@pkcprotocol/pkc-js 0.0.11

package/dist/browser/runtime/node/community/challenges/pkc-js-challenges/question.d.ts

@@ -0,0 +1,5 @@
+import type { ChallengeFileInput, CommunityChallengeSetting } from "../../../../../community/types.js";
+declare function ChallengeFileFactory({ challengeSettings }: {
+    challengeSettings: CommunityChallengeSetting;
+}): ChallengeFileInput;
+export default ChallengeFileFactory;

package/dist/browser/runtime/node/community/challenges/pkc-js-challenges/question.js

@@ -0,0 +1,66 @@
+const optionInputs = [
+    {
+        option: "question",
+        label: "Question",
+        default: "",
+        description: "The question to answer.",
+        placeholder: ""
+    },
+    {
+        option: "answer",
+        label: "Answer",
+        default: "",
+        description: "The answer to the question.",
+        placeholder: "",
+        required: true
+    }
+];
+const type = "text/plain";
+const description = `Ask a question, like 'What is the password?'`;
+const getChallenge = async ({ challengeSettings, challengeRequestMessage, challengeIndex }) => {
+    if (!challengeSettings?.options?.question)
+        throw Error("No option question");
+    let answer = challengeSettings?.options?.answer;
+    if (!answer) {
+        throw Error("no option answer");
+    }
+    // use the answer preincluded in the challenge request when possible
+    const challengeAnswer = challengeRequestMessage?.challengeAnswers?.[challengeIndex];
+    // the author didn't preinclude his answer, so send him a pubsub challenge message
+    if (challengeAnswer === undefined) {
+        return {
+            challenge: challengeSettings?.options?.question,
+            verify: async (_answer) => {
+                if (_answer === answer)
+                    return {
+                        success: true
+                    };
+                return {
+                    success: false,
+                    error: "Wrong answer."
+                };
+            },
+            type
+        };
+    }
+    // the author did preinclude his answer, but it's wrong, so send him a failed challenge verification
+    if (challengeAnswer !== answer) {
+        return {
+            success: false,
+            error: "Wrong answer."
+        };
+    }
+    // the author did preinclude his answer, and it's correct, so send him a success challenge verification
+    return {
+        success: true
+    };
+};
+function ChallengeFileFactory({ challengeSettings }) {
+    // some challenges can prepublish the challenge so that it can be preanswered
+    // in the challengeRequestMessage
+    const question = challengeSettings?.options?.question;
+    const challenge = question;
+    return { getChallenge, optionInputs, type, challenge, description };
+}
+export default ChallengeFileFactory;
+//# sourceMappingURL=question.js.map

package/dist/browser/runtime/node/community/challenges/pkc-js-challenges/question.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.js","sourceRoot":"","sources":["../../../../../../../src/runtime/browser/community/challenges/pkc-js-challenges/question.ts"],"names":[],"mappings":"AAQA,MAAM,YAAY,GAAoD;IAClE;QACI,MAAM,EAAE,UAAU;QAClB,KAAK,EAAE,UAAU;QACjB,OAAO,EAAE,EAAE;QACX,WAAW,EAAE,yBAAyB;QACtC,WAAW,EAAE,EAAE;KAClB;IACD;QACI,MAAM,EAAE,QAAQ;QAChB,KAAK,EAAE,QAAQ;QACf,OAAO,EAAE,EAAE;QACX,WAAW,EAAE,6BAA6B;QAC1C,WAAW,EAAE,EAAE;QACf,QAAQ,EAAE,IAAI;KACjB;CACJ,CAAC;AAEF,MAAM,IAAI,GAA2B,YAAY,CAAC;AAElD,MAAM,WAAW,GAAG,8CAA8C,CAAC;AAEnE,MAAM,YAAY,GAAG,KAAK,EAAE,EACxB,iBAAiB,EACjB,uBAAuB,EACvB,cAAc,EACM,EAAkD,EAAE;IACxE,IAAI,CAAC,iBAAiB,EAAE,OAAO,EAAE,QAAQ;QAAE,MAAM,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC7E,IAAI,MAAM,GAAG,iBAAiB,EAAE,OAAO,EAAE,MAAM,CAAC;IAChD,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,MAAM,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACpC,CAAC;IAED,oEAAoE;IACpE,MAAM,eAAe,GAAG,uBAAuB,EAAE,gBAAgB,EAAE,CAAC,cAAc,CAAC,CAAC;IAEpF,kFAAkF;IAClF,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO;YACH,SAAS,EAAE,iBAAiB,EAAE,OAAO,EAAE,QAAQ;YAC/C,MAAM,EAAE,KAAK,EAAE,OAAe,EAAiC,EAAE;gBAC7D,IAAI,OAAO,KAAK,MAAM;oBAClB,OAAO;wBACH,OAAO,EAAE,IAAI;qBAChB,CAAC;gBACN,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,eAAe;iBACzB,CAAC;YACN,CAAC;YACD,IAAI;SACP,CAAC;IACN,CAAC;IAED,oGAAoG;IACpG,IAAI,eAAe,KAAK,MAAM,EAAE,CAAC;QAC7B,OAAO;YACH,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,eAAe;SACzB,CAAC;IACN,CAAC;IAED,uGAAuG;IACvG,OAAO;QACH,OAAO,EAAE,IAAI;KAChB,CAAC;AACN,CAAC,CAAC;AAEF,SAAS,oBAAoB,CAAC,EAAE,iBAAiB,EAAoD;IACjG,6EAA6E;IAC7E,iCAAiC;IACjC,MAAM,QAAQ,GAAG,iBAAiB,EAAE,OAAO,EAAE,QAAQ,CAAC;IACtD,MAAM,SAAS,GAAG,QAAQ,CAAC;IAE3B,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC;AACxE,CAAC;AAED,eAAe,oBAAoB,CAAC"}

package/dist/browser/runtime/node/community/challenges/pkc-js-challenges/text-math.d.ts

@@ -0,0 +1,5 @@
+import type { ChallengeFileInput, CommunityChallengeSetting } from "../../../../../community/types.js";
+declare function ChallengeFileFactory({ challengeSettings }: {
+    challengeSettings: CommunityChallengeSetting;
+}): ChallengeFileInput;
+export default ChallengeFileFactory;

package/dist/browser/runtime/node/community/challenges/pkc-js-challenges/text-math.js

@@ -0,0 +1,61 @@
+const optionInputs = [
+    {
+        option: "difficulty",
+        label: "Difficulty",
+        default: "1",
+        description: "The math difficulty of the challenge between 1-3.",
+        placeholder: "1"
+    }
+];
+const type = "text/plain";
+const description = "Ask a plain text math question, insecure, use ONLY for testing.";
+const getRandomNumber = (minNumber, maxNumber) => Math.floor(Math.random() * (maxNumber - minNumber + 1) + minNumber);
+const getChallengeString = (minNumber, maxNumber, operators) => {
+    let firstNumber = getRandomNumber(minNumber, maxNumber);
+    let secondNumber = getRandomNumber(minNumber, maxNumber);
+    const operator = operators[getRandomNumber(0, operators.length - 1)];
+    // reduce multiply difficulty
+    if (operator === "*") {
+        firstNumber = Math.ceil(firstNumber / 10);
+        secondNumber = Math.ceil(secondNumber / 10);
+    }
+    // don't allow negative numbers
+    if (operator === "-" && firstNumber < secondNumber) {
+        const _firstNumber = firstNumber;
+        firstNumber = secondNumber;
+        secondNumber = _firstNumber;
+    }
+    return `${firstNumber} ${operator} ${secondNumber}`;
+};
+const getChallenge = async ({ challengeSettings }) => {
+    const difficultyString = challengeSettings?.options?.difficulty || "1";
+    const difficulty = Number(difficultyString);
+    let challenge;
+    if (difficulty === 1) {
+        challenge = getChallengeString(1, 10, ["+", "-"]);
+    }
+    else if (difficulty === 2) {
+        challenge = getChallengeString(10, 100, ["+", "-", "*"]);
+    }
+    else if (difficulty === 3) {
+        challenge = getChallengeString(100, 1000, ["+", "-", "*"]);
+    }
+    else {
+        throw Error(`invalid challenge difficulty '${difficulty}'`);
+    }
+    const verify = async (_answer) => {
+        if (String(eval(challenge)) === _answer) {
+            return { success: true };
+        }
+        return {
+            success: false,
+            error: "Wrong answer."
+        };
+    };
+    return { challenge, verify, type };
+};
+function ChallengeFileFactory({ challengeSettings }) {
+    return { getChallenge, optionInputs, type, description };
+}
+export default ChallengeFileFactory;
+//# sourceMappingURL=text-math.js.map

package/dist/browser/runtime/node/community/challenges/pkc-js-challenges/text-math.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-math.js","sourceRoot":"","sources":["../../../../../../../src/runtime/browser/community/challenges/pkc-js-challenges/text-math.ts"],"names":[],"mappings":"AAQA,MAAM,YAAY,GAAoD;IAClE;QACI,MAAM,EAAE,YAAY;QACpB,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,GAAG;QACZ,WAAW,EAAE,mDAAmD;QAChE,WAAW,EAAE,GAAG;KACnB;CACJ,CAAC;AAEF,MAAM,IAAI,GAA2B,YAAY,CAAC;AAElD,MAAM,WAAW,GAAsC,iEAAiE,CAAC;AAEzH,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAE,SAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,SAAS,GAAG,SAAS,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;AAEtI,MAAM,kBAAkB,GAAG,CAAC,SAAiB,EAAE,SAAiB,EAAE,SAAoC,EAAE,EAAE;IACtG,IAAI,WAAW,GAAG,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACxD,IAAI,YAAY,GAAG,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACzD,MAAM,QAAQ,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACrE,6BAA6B;IAC7B,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;QACnB,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC;QAC1C,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC,CAAC;IAChD,CAAC;IACD,+BAA+B;IAC/B,IAAI,QAAQ,KAAK,GAAG,IAAI,WAAW,GAAG,YAAY,EAAE,CAAC;QACjD,MAAM,YAAY,GAAG,WAAW,CAAC;QACjC,WAAW,GAAG,YAAY,CAAC;QAC3B,YAAY,GAAG,YAAY,CAAC;IAChC,CAAC;IACD,OAAO,GAAG,WAAW,IAAI,QAAQ,IAAI,YAAY,EAAE,CAAC;AACxD,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,KAAK,EAAE,EAAE,iBAAiB,EAAyB,EAA2B,EAAE;IACjG,MAAM,gBAAgB,GAAG,iBAAiB,EAAE,OAAO,EAAE,UAAU,IAAI,GAAG,CAAC;IACvE,MAAM,UAAU,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAE5C,IAAI,SAAiB,CAAC;IACtB,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;QACnB,SAAS,GAAG,kBAAkB,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;SAAM,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;QAC1B,SAAS,GAAG,kBAAkB,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IAC7D,CAAC;SAAM,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;QAC1B,SAAS,GAAG,kBAAkB,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IAC/D,CAAC;SAAM,CAAC;QACJ,MAAM,KAAK,CAAC,iCAAiC,UAAU,GAAG,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,MAAM,GAAG,KAAK,EAAE,OAAe,EAAiC,EAAE;QACpE,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC;YACtC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAC7B,CAAC;QACD,OAAO;YACH,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,eAAe;SACzB,CAAC;IACN,CAAC,CAAC;IACF,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AACvC,CAAC,CAAC;AAEF,SAAS,oBAAoB,CAAC,EAAE,iBAAiB,EAAoD;IACjG,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;AAC7D,CAAC;AAED,eAAe,oBAAoB,CAAC"}

package/dist/browser/runtime/node/community/challenges/pkc-js-challenges/whitelist.d.ts

@@ -0,0 +1,5 @@
+import type { ChallengeFileInput, CommunityChallengeSetting } from "../../../../../community/types.js";
+declare function ChallengeFileFactory({ challengeSettings }: {
+    challengeSettings: CommunityChallengeSetting;
+}): ChallengeFileInput;
+export default ChallengeFileFactory;

package/dist/browser/runtime/node/community/challenges/pkc-js-challenges/whitelist.js

@@ -0,0 +1,118 @@
+import { derivePublicationFromChallengeRequest } from "../../../../../util.js";
+import { getCommunityAddressFromRecord } from "../../../../../publications/publication-community.js";
+const optionInputs = [
+    {
+        option: "addresses",
+        label: "Addresses",
+        default: "",
+        description: "Comma separated list of author addresses to be whitelisted.",
+        placeholder: `address1.bso,address2.bso,address3.bso`
+    },
+    {
+        option: "urls",
+        label: "URLs",
+        default: "",
+        description: "Comma separated list of URLs to fetch whitelists from (JSON arrays of addresses)",
+        placeholder: `https://example.com/file.json,https://github.com/whitelist.json`
+    },
+    {
+        option: "error",
+        label: "Error",
+        default: `You're not whitelisted.`,
+        description: "The error to display to the author.",
+        placeholder: `You're not whitelisted.`
+    }
+];
+const type = "text/plain";
+const description = "Whitelist author addresses.";
+class UrlsAddressesSet {
+    constructor() {
+        this.communities = {};
+        // refetch all urls in the background every 5min
+        setInterval(() => this.refetchAndUpdateAllUrlsSets(), 1000 * 60 * 5).unref?.();
+    }
+    async has(address, communityAddress, urlsString) {
+        if (!address || !communityAddress || !urlsString)
+            return false;
+        // update urls on first run, wait for 10s max
+        await this.setUrls(communityAddress, urlsString);
+        const community = this.communities[communityAddress];
+        const urlsSets = community.urls.map((url) => community.urlsSets[url]).filter(Boolean);
+        for (const urlSet of urlsSets) {
+            if (urlSet.has(address)) {
+                return true;
+            }
+        }
+        return false;
+    }
+    async setUrls(communityAddress, urlsString) {
+        let community = this.communities[communityAddress];
+        if (community && urlsString === community.urlsString) {
+            return community.setUrlsPromise;
+        }
+        this.communities[communityAddress] = {
+            urlsString,
+            urls: urlsString
+                ?.split(",")
+                .map((u) => u.trim())
+                .filter(Boolean) || [],
+            urlsSets: {}
+        };
+        // try fetching urls before resolving
+        this.communities[communityAddress].setUrlsPromise = Promise.race([
+            Promise.all(this.communities[communityAddress].urls.map((url) => this.fetchAndUpdateUrlSet(url, [communityAddress]))).then(() => { }),
+            // make sure to resolve after max 10s, or the initial urlsAddressesSet.has() could take infinite time
+            new Promise((resolve) => setTimeout(resolve, 10000))
+        ]);
+        return this.communities[communityAddress].setUrlsPromise;
+    }
+    async fetchAndUpdateUrlSet(url, communityAddresses) {
+        try {
+            const addresses = await fetch(url).then((res) => res.json());
+            for (const communityAddress of communityAddresses) {
+                this.communities[communityAddress].urlsSets[url] = new Set(addresses);
+            }
+        }
+        catch { }
+    }
+    refetchAndUpdateAllUrlsSets() {
+        const urlToCommunityAddresses = {};
+        for (const [communityAddress, community] of Object.entries(this.communities)) {
+            for (const url of community.urls) {
+                if (!urlToCommunityAddresses[url]) {
+                    urlToCommunityAddresses[url] = [];
+                }
+                urlToCommunityAddresses[url].push(communityAddress);
+            }
+        }
+        for (const [url, communityAddresses] of Object.entries(urlToCommunityAddresses)) {
+            this.fetchAndUpdateUrlSet(url, communityAddresses);
+        }
+    }
+}
+const urlsAddressesSet = new UrlsAddressesSet();
+const getChallenge = async ({ challengeSettings, challengeRequestMessage }) => {
+    // add a custom error message to display to the author
+    const error = challengeSettings?.options?.error;
+    const addresses = challengeSettings?.options?.addresses
+        ?.split(",")
+        .map((u) => u.trim())
+        .filter(Boolean);
+    const addressesSet = new Set(addresses);
+    const publication = derivePublicationFromChallengeRequest(challengeRequestMessage);
+    if (!addressesSet.has(publication?.author?.address) &&
+        !(await urlsAddressesSet.has(publication?.author?.address, getCommunityAddressFromRecord(publication), challengeSettings?.options?.urls))) {
+        return {
+            success: false,
+            error: error || `You're not whitelisted.`
+        };
+    }
+    return {
+        success: true
+    };
+};
+function ChallengeFileFactory({ challengeSettings }) {
+    return { getChallenge, optionInputs, type, description };
+}
+export default ChallengeFileFactory;
+//# sourceMappingURL=whitelist.js.map

package/dist/browser/runtime/node/community/challenges/pkc-js-challenges/whitelist.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whitelist.js","sourceRoot":"","sources":["../../../../../../../src/runtime/browser/community/challenges/pkc-js-challenges/whitelist.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,qCAAqC,EAAE,MAAM,wBAAwB,CAAC;AAC/E,OAAO,EAAE,6BAA6B,EAAE,MAAM,sDAAsD,CAAC;AAErG,MAAM,YAAY,GAAoD;IAClE;QACI,MAAM,EAAE,WAAW;QACnB,KAAK,EAAE,WAAW;QAClB,OAAO,EAAE,EAAE;QACX,WAAW,EAAE,6DAA6D;QAC1E,WAAW,EAAE,wCAAwC;KACxD;IACD;QACI,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,EAAE;QACX,WAAW,EAAE,kFAAkF;QAC/F,WAAW,EAAE,iEAAiE;KACjF;IACD;QACI,MAAM,EAAE,OAAO;QACf,KAAK,EAAE,OAAO;QACd,OAAO,EAAE,yBAAyB;QAClC,WAAW,EAAE,qCAAqC;QAClD,WAAW,EAAE,yBAAyB;KACzC;CACJ,CAAC;AAEF,MAAM,IAAI,GAA2B,YAAY,CAAC;AAElD,MAAM,WAAW,GAAG,6BAA6B,CAAC;AAElD,MAAM,gBAAgB;IAUlB;QATQ,gBAAW,GAOf,EAAE,CAAC;QAGH,gDAAgD;QAChD,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;IACnF,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,OAAgB,EAAE,gBAAyB,EAAE,UAAmB;QACtE,IAAI,CAAC,OAAO,IAAI,CAAC,gBAAgB,IAAI,CAAC,UAAU;YAAE,OAAO,KAAK,CAAC;QAC/D,6CAA6C;QAC7C,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtF,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;YAC5B,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtB,OAAO,IAAI,CAAC;YAChB,CAAC;QACL,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,gBAAwB,EAAE,UAAkB;QAC9D,IAAI,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QACnD,IAAI,SAAS,IAAI,UAAU,KAAK,SAAS,CAAC,UAAU,EAAE,CAAC;YACnD,OAAO,SAAS,CAAC,cAAc,CAAC;QACpC,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,GAAG;YACjC,UAAU;YACV,IAAI,EACA,UAAU;gBACN,EAAE,KAAK,CAAC,GAAG,CAAC;iBACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;iBACpB,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE;YAC9B,QAAQ,EAAE,EAAE;SACf,CAAC;QACF,qCAAqC;QACrC,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;YAC7D,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CACtH,GAAG,EAAE,GAAE,CAAC,CACX;YACD,qGAAqG;YACrG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;SAC7D,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,cAAc,CAAC;IAC7D,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,GAAW,EAAE,kBAA4B;QACxE,IAAI,CAAC;YACD,MAAM,SAAS,GAAa,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAuB,CAAC,CAAC;YAC5F,KAAK,MAAM,gBAAgB,IAAI,kBAAkB,EAAE,CAAC;gBAChD,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;YAC1E,CAAC;QACL,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACd,CAAC;IAEO,2BAA2B;QAC/B,MAAM,uBAAuB,GAAgC,EAAE,CAAC;QAChE,KAAK,MAAM,CAAC,gBAAgB,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3E,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;gBAC/B,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,CAAC;oBAChC,uBAAuB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;gBACtC,CAAC;gBACD,uBAAuB,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACxD,CAAC;QACL,CAAC;QACD,KAAK,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,EAAE,CAAC;YAC9E,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;QACvD,CAAC;IACL,CAAC;CACJ;AACD,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,EAAE,CAAC;AAEhD,MAAM,YAAY,GAAG,KAAK,EAAE,EAAE,iBAAiB,EAAE,uBAAuB,EAAyB,EAAiC,EAAE;IAChI,sDAAsD;IACtD,MAAM,KAAK,GAAG,iBAAiB,EAAE,OAAO,EAAE,KAAK,CAAC;IAChD,MAAM,SAAS,GAAG,iBAAiB,EAAE,OAAO,EAAE,SAAS;QACnD,EAAE,KAAK,CAAC,GAAG,CAAC;SACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,OAAO,CAAC,CAAC;IACrB,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IAExC,MAAM,WAAW,GAAG,qCAAqC,CAAC,uBAAuB,CAAC,CAAC;IACnF,IACI,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC;QAC/C,CAAC,CAAC,MAAM,gBAAgB,CAAC,GAAG,CACxB,WAAW,EAAE,MAAM,EAAE,OAAO,EAC5B,6BAA6B,CAAC,WAAiD,CAAC,EAChF,iBAAiB,EAAE,OAAO,EAAE,IAAI,CACnC,CAAC,EACJ,CAAC;QACC,OAAO;YACH,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,KAAK,IAAI,yBAAyB;SAC5C,CAAC;IACN,CAAC;IAED,OAAO;QACH,OAAO,EAAE,IAAI;KAChB,CAAC;AACN,CAAC,CAAC;AAEF,SAAS,oBAAoB,CAAC,EAAE,iBAAiB,EAAoD;IACjG,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;AAC7D,CAAC;AAED,eAAe,oBAAoB,CAAC"}

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

@@ -0,0 +1,19 @@
+import type { CommentsTableRow, CommentUpdatesRow } from "../../../publications/comment/types.js";
+import type { SignerType } from "../../../signer/types.js";
+import type { CommunityIpfsType } from "../../../community/types.js";
+export type PurgedCommentTableRows = {
+    commentTableRow: CommentsTableRow;
+    commentUpdateTableRow?: CommentUpdatesRow;
+};
+export type CommentCidWithReplies = Pick<CommentsTableRow, "cid"> & Pick<CommentUpdatesRow, "replies">;
+type Features = NonNullable<CommunityIpfsType["features"]>;
+type PseudonymityMode = NonNullable<Features["pseudonymityMode"]>;
+export type PseudonymityAliasRow = {
+    commentCid: CommentsTableRow["cid"];
+    aliasPrivateKey: SignerType["privateKey"];
+    originalAuthorSignerPublicKey: NonNullable<SignerType["publicKey"]>;
+    originalAuthorDomain: string | null;
+    mode: PseudonymityMode;
+    insertedAt: number;
+};
+export {};

package/dist/browser/runtime/node/community/db-handler-types.js

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

package/dist/browser/runtime/node/community/db-handler-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"db-handler-types.js","sourceRoot":"","sources":["../../../../../src/runtime/browser/community/db-handler-types.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,226 @@
+import Database, { type Database as BetterSqlite3Database } from "better-sqlite3";
+import type { PageOptions } from "./page-generator.js";
+import type { InternalCommunityRecordBeforeFirstUpdateType, CommunityStats } from "../../../community/types.js";
+import type { CommentEditsTableRow, CommentEditsTableRowInsert } from "../../../publications/comment-edit/types.js";
+import type { CommentsTableRow, CommentsTableRowInsert, CommentUpdatesRow, CommentUpdatesTableRowInsert, CommentUpdateType, CommunityAuthor } from "../../../publications/comment/types.js";
+import type { PageIpfs } from "../../../pages/types.js";
+import type { CommentModerationsTableRowInsert } from "../../../publications/comment-moderation/types.js";
+import type { VotesTableRow, VotesTableRowInsert } from "../../../publications/vote/types.js";
+import type { PseudonymityAliasRow, CommentCidWithReplies, PurgedCommentTableRows } from "./db-handler-types.js";
+export declare class DbHandler {
+    _db: BetterSqlite3Database;
+    private _community;
+    private _transactionDepth;
+    private _dbConfig;
+    private _keyv;
+    private _createdTables;
+    constructor(community: DbHandler["_community"]);
+    private _parsePrefixedComment;
+    private _parseCommentsTableRow;
+    private _parseCommentUpdatesRow;
+    private _parseCommentEditsRow;
+    private _parseVoteRow;
+    initDbConfigIfNeeded(): Promise<void>;
+    toJSON(): undefined;
+    initDbIfNeeded(dbConfigOptions?: Partial<DbHandler["_dbConfig"]>): Promise<void>;
+    createOrMigrateTablesIfNeeded(): Promise<void>;
+    getDbConfig(): {
+        filename: string;
+    } & Database.Options;
+    keyvGet<Value>(key: string): Value | undefined;
+    keyvSet(key: string, value: any, ttl?: number): any;
+    keyvDelete(key: string): boolean;
+    keyvHas(key: string): boolean;
+    destoryConnection(): void;
+    createTransaction(): void;
+    commitTransaction(): void;
+    rollbackTransaction(): void;
+    rollbackAllTransactions(): Promise<void>;
+    private _createCommentsTable;
+    private _createCommentUpdatesTable;
+    private _createVotesTable;
+    private _createCommentEditsTable;
+    private _createCommentModerationsTable;
+    private _createPseudonymityAliasesTable;
+    getDbVersion(): number;
+    _migrateOldSettings(oldSettings: InternalCommunityRecordBeforeFirstUpdateType["settings"]): {
+        fetchThumbnailUrls?: boolean | undefined;
+        fetchThumbnailUrlsProxyUrl?: string | undefined;
+        challenges?: {
+            path?: string | undefined;
+            name?: string | undefined;
+            options?: Record<string, string> | undefined;
+            exclude?: {
+                [x: string]: unknown;
+                community?: {
+                    addresses: string[];
+                    maxCommentCids: number;
+                    postScore?: number | undefined;
+                    replyScore?: number | undefined;
+                    firstCommentTimestamp?: number | undefined;
+                } | undefined;
+                postScore?: number | undefined;
+                replyScore?: number | undefined;
+                postCount?: number | undefined;
+                replyCount?: number | undefined;
+                firstCommentTimestamp?: number | undefined;
+                challenges?: number[] | undefined;
+                role?: string[] | undefined;
+                address?: string[] | undefined;
+                rateLimit?: number | undefined;
+                rateLimitChallengeSuccess?: boolean | undefined;
+                publicationType?: {
+                    [x: string]: unknown;
+                    post?: boolean | undefined;
+                    reply?: boolean | undefined;
+                    vote?: boolean | undefined;
+                    commentEdit?: boolean | undefined;
+                    commentModeration?: boolean | undefined;
+                    communityEdit?: boolean | undefined;
+                } | undefined;
+            }[] | undefined;
+            description?: string | undefined;
+            pendingApproval?: boolean | undefined;
+        }[] | undefined;
+        maxPendingApprovalCount?: number | undefined;
+        purgeDisapprovedCommentsOlderThan?: number | undefined;
+    };
+    _createOrMigrateTablesIfNeeded(): Promise<void>;
+    private _tableExists;
+    private _backfillApprovedCommentNumbers;
+    private _backfillTargetAuthorSignerAddress;
+    private _backfillTargetAuthorDomain;
+    private _getColumnNames;
+    private _copyTable;
+    private _purgePublicationTablesWithDuplicateSignatures;
+    private _purgeCommentEditsWithInvalidSchemaOrSignature;
+    private _purgeCommentsWithInvalidSchemaOrSignature;
+    deleteVote(authorSignerAddress: VotesTableRow["authorSignerAddress"], commentCid: VotesTableRow["commentCid"]): void;
+    private _deleteCommentEditRow;
+    insertVotes(votes: VotesTableRowInsert[]): void;
+    insertComments(comments: CommentsTableRowInsert[]): void;
+    insertPseudonymityAliases(aliases: PseudonymityAliasRow[]): void;
+    upsertCommentUpdates(updates: CommentUpdatesTableRowInsert[]): void;
+    insertCommentModerations(moderations: CommentModerationsTableRowInsert[]): void;
+    insertCommentEdits(edits: CommentEditsTableRowInsert[]): void;
+    queryVote(commentCid: string, authorSignerAddress: string): VotesTableRow | undefined;
+    private _approvedClause;
+    private _removedClause;
+    private _deletedFromUpdatesClause;
+    private _deletedFromLookupClause;
+    private _pendingApprovalClause;
+    private _communityAddressClause;
+    private _communityAddressClauseNamed;
+    private _buildPageQueryParts;
+    queryMaximumTimestampUnderComment(comment: Pick<CommentsTableRow, "cid">): number | undefined;
+    queryPageComments(options: Omit<PageOptions, "firstPageSizeBytes">): PageIpfs["comments"];
+    queryFlattenedPageReplies(options: Omit<PageOptions, "firstPageSizeBytes"> & {
+        parentCid: string;
+    }): PageIpfs["comments"];
+    queryStoredCommentUpdate(comment: Pick<CommentsTableRow, "cid">): CommentUpdatesRow | undefined;
+    hasCommentWithSignatureEncoded(signatureEncoded: string): boolean;
+    queryCommentBySignatureEncoded(signatureEncoded: string): CommentsTableRow | undefined;
+    hasCommentModerationWithSignatureEncoded(signatureEncoded: string): boolean;
+    hasCommentEditWithSignatureEncoded(signatureEncoded: string): boolean;
+    queryParentsCids(rootComment: Pick<CommentsTableRow, "parentCid">): Pick<CommentsTableRow, "cid">[];
+    queryCommentsPendingApproval(): CommentsTableRow[];
+    queryCommentsToBeUpdated(): CommentsTableRow[];
+    queryCommunityStats(): CommunityStats;
+    queryCommentsUnderComment(parentCid: string | null): CommentsTableRow[];
+    queryFirstCommentWithDepth(commentDepth: number): CommentsTableRow | undefined;
+    queryCombinedHashOfPendingComments(): string;
+    queryComment(cid: string): CommentsTableRow | undefined;
+    queryPseudonymityAliasByCommentCid(commentCid: string): PseudonymityAliasRow | undefined;
+    queryPseudonymityAliasForPost(originalAuthorSignerPublicKey: string, postCid: string): PseudonymityAliasRow | undefined;
+    queryPseudonymityAliasForAuthor(originalAuthorSignerPublicKey: string): PseudonymityAliasRow | undefined;
+    private _queryCommentAuthorAndParentWithoutParsing;
+    private _queryCommentCounts;
+    queryPostsWithOutdatedBuckets(buckets: number[]): {
+        cid: string;
+        timestamp: number;
+        currentBucket: number;
+        newBucket: number;
+    }[];
+    private _queryLatestAuthorEdit;
+    removeCommentFromPendingApproval(comment: Pick<CommentsTableRow, "cid">): void;
+    approvePendingComment(comment: Pick<CommentsTableRow, "cid">): {
+        number?: number;
+        postNumber?: number;
+    };
+    getNextCommentNumbers(depth: number): {
+        number: number;
+        postNumber?: number;
+    };
+    _assignNumbersForComment(commentCid: string): {
+        number?: number;
+        postNumber?: number;
+    };
+    removeOldestPendingCommentIfWeHitMaxPendingCount(maxPendingApprovalCount: number): void;
+    purgeDisapprovedCommentsOlderThan(retentionSeconds: number): {
+        cid: string;
+        parentCid?: string | null;
+        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">;
+        authorDomain?: string;
+    }): Omit<CommentUpdateType, "signature" | "updatedAt" | "replies" | "protocolVersion">;
+    queryLatestPostCid(): Pick<CommentsTableRow, "cid"> | undefined;
+    queryLatestCommentCid(): Pick<CommentsTableRow, "cid"> | undefined;
+    queryAllCommentsOrderedByIdAsc(): CommentsTableRow[];
+    queryAuthorModEdits(opts: {
+        authorSignerAddresses: string[];
+        authorDomain?: string;
+    }): Pick<CommunityAuthor, "banExpiresAt" | "flairs">;
+    queryAuthorPublicationCounts(authorSignerAddress: string): {
+        postCount: number;
+        replyCount: number;
+    };
+    queryCommunityAuthor(authorSignerAddress: string, authorDomain?: string): CommunityAuthor | undefined;
+    /** Shared helper: query karma for a set of addresses, with optional separate addresses for mod edits */
+    private _queryCommunityAuthorByAddresses;
+    /**
+     * Returns author.community for CommentUpdates, respecting pseudonymity mode boundaries.
+     *
+     * The alias address already encodes the isolation boundary:
+     * - per-reply: Each reply has a unique alias, so querying by alias = that one comment's karma
+     * - per-post: All comments in a thread share an alias, so querying by alias = thread karma
+     * - per-author: One alias for all comments, so querying by alias = total karma
+     *
+     * 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>;
+    lockCommunityStart(communityAddress?: string): Promise<void>;
+    unlockCommunityStart(communityAddress?: string): Promise<void>;
+    isCommunityStartLocked(communityAddress?: string): Promise<boolean>;
+    lockCommunityState(): Promise<void>;
+    unlockCommunityState(): Promise<void>;
+    communityDbExists(): boolean;
+    markCommentsAsPublishedToPostUpdates(commentCids: string[]): void;
+    forceUpdateOnAllComments(): void;
+    forceUpdateOnAllCommentsWithCid(commentCids: string[]): void;
+    queryAllCommentCidsAndTheirReplies(): CommentCidWithReplies[];
+    queryPostsWithActiveScore(pageOptions: Omit<PageOptions, "pageSize" | "preloadedPage" | "baseTimestamp" | "firstPageSizeBytes">): (PageIpfs["comments"][0] & {
+        activeScore: number;
+    })[];
+    private _processRecordsForDbBeforeInsert;
+    private _spreadExtraProps;
+}