@bitsocial/bitsocial-cli 0.19.39 → 0.19.41

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bitsocial/bitsocial-cli",
-    "version": "0.19.39",
+    "version": "0.19.41",
     "description": "Command line interface to Bitsocial API",
     "types": "./dist/index.d.ts",
     "homepage": "https://github.com/bitsocialnet/bitsocial-cli",
@@ -8,7 +8,9 @@
     "author": "Bitsocial Labs",
     "license": "GPL-3.0-or-later",
     "type": "module",
-    "publishConfig": { "access": "public" },
+    "publishConfig": {
+        "access": "public"
+    },
     "exports": null,
     "scripts": {
         "clean": "rm -rf tmp/",

package/dist/cli/commands/subplebbit/create.d.ts

@@ -1,12 +0,0 @@
-import { BaseCommand } from "../../base-command.js";
-export default class Create extends BaseCommand {
-    static description: string;
-    static examples: {
-        description: string;
-        command: string;
-    }[];
-    static flags: {
-        privateKeyPath: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-}

package/dist/cli/commands/subplebbit/create.js

@@ -1,54 +0,0 @@
-import { Flags } from "@oclif/core";
-//@ts-ignore
-import DataObjectParser from "dataobject-parser";
-import fs from "fs";
-import { BaseCommand } from "../../base-command.js";
-import { getPlebbitLogger } from "../../../util.js";
-import * as remeda from "remeda";
-export default class Create extends BaseCommand {
-    static description = "Create a subplebbit with specific properties. A newly created sub will be started after creation and be able to receive publications. For a list of properties, visit https://github.com/plebbit/plebbit-js#subplebbiteditsubplebbiteditoptions";
-    static examples = [
-        {
-            description: "Create a subplebbit with title 'Hello Plebs' and description 'Welcome'",
-            command: "<%= config.bin %> <%= command.id %> --title 'Hello Plebs' --description 'Welcome'"
-        }
-    ];
-    static flags = {
-        privateKeyPath: Flags.file({
-            exists: true,
-            description: "Private key (PEM) of the subplebbit signer that will be used to determine address (if address is not a domain). If it's not provided then Plebbit will generate a private key"
-        })
-    };
-    async run() {
-        const { flags } = await this.parse(Create);
-        const log = (await getPlebbitLogger())("plebbit-cli:commands:subplebbit:create");
-        log(`flags: `, flags);
-        const plebbit = await this._connectToPlebbitRpc(flags.plebbitRpcUrl.toString());
-        const createOptions = DataObjectParser.transpose(remeda.omit(flags, ["plebbitRpcUrl", "privateKeyPath"]))["_data"];
-        if (flags.privateKeyPath)
-            try {
-                //@ts-expect-error
-                createOptions.signer = { privateKey: (await fs.promises.readFile(flags.privateKeyPath)).toString(), type: "ed25519" };
-            }
-            catch (e) {
-                const error = e;
-                //@ts-expect-error
-                error.details = { ...error.details, privateKeyPath: flags.privateKeyPath };
-                await plebbit.destroy();
-                this.error(error);
-            }
-        try {
-            const createdSub = await plebbit.createSubplebbit(createOptions);
-            await createdSub.start();
-            this.log(createdSub.address);
-        }
-        catch (e) {
-            const error = e;
-            //@ts-expect-error
-            error.details = { ...error.details, createOptions };
-            await plebbit.destroy();
-            this.error(error);
-        }
-        await plebbit.destroy();
-    }
-}

package/dist/cli/commands/subplebbit/edit.d.ts

@@ -1,12 +0,0 @@
-import { BaseCommand } from "../../base-command.js";
-export default class Edit extends BaseCommand {
-    static description: string;
-    static args: {
-        address: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
-    static examples: {
-        description: string;
-        command: string;
-    }[];
-    run(): Promise<void>;
-}

package/dist/cli/commands/subplebbit/edit.js

@@ -1,73 +0,0 @@
-//@ts-expect-error
-import DataObjectParser from "dataobject-parser";
-import { Args } from "@oclif/core";
-import { BaseCommand } from "../../base-command.js";
-import { getPlebbitLogger, mergeDeep } from "../../../util.js";
-import * as remeda from "remeda";
-export default class Edit extends BaseCommand {
-    static description = "Edit a subplebbit properties. For a list of properties, visit https://github.com/plebbit/plebbit-js#subplebbiteditsubplebbiteditoptions";
-    static args = {
-        address: Args.string({
-            name: "address",
-            required: true,
-            description: "Address of the subplebbit address to edit"
-        })
-    };
-    static examples = [
-        {
-            description: "Change the address of the sub to a new ENS address",
-            command: "plebbit subplebbit edit 12D3KooWG3XbzoVyAE6Y9vHZKF64Yuuu4TjdgQKedk14iYmTEPWu --address newAddress.eth"
-        },
-        {
-            description: "Add the author address 'esteban.eth' as an admin on the sub",
-            command: `plebbit subplebbit edit mysub.eth '--roles["esteban.eth"].role' admin`
-        },
-        {
-            description: "Add two challenges to the sub. The first challenge will be a question and answer, and the second will be an image captcha",
-            command: `plebbit subplebbit edit mysub.eth --settings.challenges[0].name question --settings.challenges[0].options.question "what is the password?" --settings.challenges[0].options.answer thepassword --settings.challenges[1].name captcha-canvas-v3`
-        },
-        {
-            description: "Change the title and description",
-            command: `plebbit subplebbit edit mysub.eth --title "This is the new title" --description "This is the new description" `
-        },
-        {
-            description: "Remove a role from a moderator/admin/owner",
-            command: "plebbit subplebbit edit plebbit.eth --roles['rinse12.eth'] null"
-        },
-        {
-            description: "Enable settings.fetchThumbnailUrls to fetch the thumbnail of url submitted by authors",
-            command: "subplebbit edit plebbit.eth --settings.fetchThumbnailUrls"
-        },
-        {
-            description: "disable settings.fetchThumbnailUrls",
-            command: "subplebbit edit plebbit.eth --settings.fetchThumbnailUrls=false"
-        }
-    ];
-    async run() {
-        const { flags, args } = await this.parse(Edit);
-        const log = (await getPlebbitLogger())("plebbit-cli:commands:subplebbit:edit");
-        log(`flags: `, flags);
-        const plebbit = await this._connectToPlebbitRpc(flags.plebbitRpcUrl.toString());
-        const editOptions = DataObjectParser.transpose(remeda.omit(flags, ["plebbitRpcUrl"]))["_data"];
-        log("Edit options parsed:", editOptions);
-        const localSubs = plebbit.subplebbits;
-        if (!localSubs.includes(args.address))
-            this.error("Can't edit a remote subplebbit, make sure you're editing a local sub");
-        try {
-            const sub = await plebbit.createSubplebbit({ address: args.address });
-            const mergedSubState = remeda.pick(sub, remeda.keys.strict(editOptions));
-            const finalMergedState = mergeDeep(mergedSubState, editOptions);
-            log("Internal sub state after merge:", finalMergedState);
-            await sub.edit(finalMergedState);
-            this.log(sub.address);
-        }
-        catch (e) {
-            //@ts-expect-error
-            e.details = { ...e.details, editOptions, address: args.address };
-            console.error(e);
-            await plebbit.destroy();
-            this.exit(1);
-        }
-        await plebbit.destroy();
-    }
-}

package/dist/cli/commands/subplebbit/get.d.ts

@@ -1,9 +0,0 @@
-import { BaseCommand } from "../../base-command.js";
-export default class Get extends BaseCommand {
-    static description: string;
-    static examples: string[];
-    static args: {
-        address: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
-    run(): Promise<void>;
-}

package/dist/cli/commands/subplebbit/get.js

@@ -1,32 +0,0 @@
-import { Args } from "@oclif/core";
-import { BaseCommand } from "../../base-command.js";
-import * as remeda from "remeda";
-export default class Get extends BaseCommand {
-    static description = "Fetch a local or remote subplebbit, and print its json in the terminal";
-    static examples = [
-        "plebbit subplebbit get plebmusic.eth",
-        "plebbit subplebbit get 12D3KooWG3XbzoVyAE6Y9vHZKF64Yuuu4TjdgQKedk14iYmTEPWu"
-    ];
-    static args = {
-        address: Args.string({
-            name: "address",
-            required: true,
-            description: "Address of the subplebbit address to fetch"
-        })
-    };
-    async run() {
-        const { args, flags } = await this.parse(Get);
-        const plebbit = await this._connectToPlebbitRpc(flags.plebbitRpcUrl.toString());
-        try {
-            const sub = await plebbit.getSubplebbit({ address: args.address });
-            const subJson = JSON.parse(JSON.stringify(sub));
-            this.logJson({ posts: subJson.posts, ...remeda.omit(subJson, ["posts"]) }); // make sure posts is printed first, because most users won't look at it
-        }
-        catch (e) {
-            console.error(e);
-            await plebbit.destroy();
-            this.exit(1);
-        }
-        await plebbit.destroy();
-    }
-}

package/dist/cli/commands/subplebbit/list.d.ts

@@ -1,9 +0,0 @@
-import { BaseCommand } from "../../base-command.js";
-export default class List extends BaseCommand {
-    static description: string;
-    static examples: string[];
-    static flags: {
-        quiet: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-    };
-    run(): Promise<void>;
-}

package/dist/cli/commands/subplebbit/list.js

@@ -1,30 +0,0 @@
-import { Flags } from "@oclif/core";
-import { BaseCommand } from "../../base-command.js";
-import { EOL } from "os";
-import { getPlebbitLogger } from "../../../util.js";
-import { printTable } from "@oclif/table";
-export default class List extends BaseCommand {
-    static description = "List your subplebbits";
-    static examples = ["plebbit subplebbit list -q", "plebbit subplebbit list"];
-    static flags = {
-        quiet: Flags.boolean({ char: "q", summary: "Only display subplebbit addresses" })
-    };
-    async run() {
-        const { flags } = await this.parse(List);
-        const log = (await getPlebbitLogger())("plebbit-cli:commands:subplebbit:list");
-        log(`flags: `, flags);
-        const plebbit = await this._connectToPlebbitRpc(flags.plebbitRpcUrl.toString());
-        const subs = plebbit.subplebbits;
-        if (flags.quiet) {
-            this.log(subs.join(EOL));
-        }
-        else {
-            const subsWithStarted = await Promise.all(subs.map(async (subAddress) => {
-                const subInstance = await plebbit.createSubplebbit({ address: subAddress });
-                return { address: subInstance.address, started: subInstance.started };
-            }));
-            printTable({ data: subsWithStarted, sort: { started: "desc" } });
-        }
-        await plebbit.destroy();
-    }
-}

package/dist/cli/commands/subplebbit/start.d.ts

@@ -1,10 +0,0 @@
-import { BaseCommand } from "../../base-command.js";
-export default class Start extends BaseCommand {
-    static description: string;
-    static strict: boolean;
-    static args: {
-        addresses: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
-    static examples: string[];
-    run(): Promise<void>;
-}

package/dist/cli/commands/subplebbit/start.js

@@ -1,41 +0,0 @@
-import { getPlebbitLogger } from "../../../util.js";
-import { BaseCommand } from "../../base-command.js";
-import { Args } from "@oclif/core";
-export default class Start extends BaseCommand {
-    static description = "Start a subplebbit";
-    static strict = false; // To allow for variable length arguments
-    static args = {
-        addresses: Args.string({
-            name: "addresses", // name of arg to show in help and reference with args[name]
-            required: true,
-            description: "Addresses of subplebbits to start. Separated by space"
-        })
-    };
-    static examples = [
-        "plebbit subplebbit start plebbit.eth",
-        "plebbit subplebbit start 12D3KooWG3XbzoVyAE6Y9vHZKF64Yuuu4TjdgQKedk14iYmTEPWu"
-    ];
-    async run() {
-        const { argv, flags } = await this.parse(Start);
-        const addresses = argv;
-        const log = (await getPlebbitLogger())("plebbit-cli:commands:subplebbit:start");
-        log(`addresses: `, addresses);
-        log(`flags: `, flags);
-        const plebbit = await this._connectToPlebbitRpc(flags.plebbitRpcUrl.toString());
-        for (const address of addresses) {
-            try {
-                const sub = await plebbit.createSubplebbit({ address });
-                await sub.start();
-                this.log(address);
-            }
-            catch (e) {
-                //@ts-expect-error
-                e.details = { ...e.details, address };
-                console.error(e);
-                await plebbit.destroy();
-                this.exit(1);
-            }
-        }
-        await plebbit.destroy();
-    }
-}

package/dist/cli/commands/subplebbit/stop.d.ts

@@ -1,10 +0,0 @@
-import { BaseCommand } from "../../base-command.js";
-export default class Stop extends BaseCommand {
-    static description: string;
-    static strict: boolean;
-    static args: {
-        addresses: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
-    static examples: string[];
-    run(): Promise<void>;
-}

package/dist/cli/commands/subplebbit/stop.js

@@ -1,43 +0,0 @@
-import { getPlebbitLogger } from "../../../util.js";
-import { BaseCommand } from "../../base-command.js";
-import { Args } from "@oclif/core";
-export default class Stop extends BaseCommand {
-    static description = "Stop a subplebbit. The subplebbit will not publish or receive any publications until it is started again.";
-    static strict = false; // To allow for variable length arguments
-    static args = {
-        addresses: Args.string({
-            name: "addresses",
-            required: true,
-            description: "Addresses of subplebbits to stop. Separated by space"
-        })
-    };
-    static examples = [
-        "plebbit subplebbit stop plebbit.eth",
-        "plebbit subplebbit stop Qmb99crTbSUfKXamXwZBe829Vf6w5w5TktPkb6WstC9RFW"
-    ];
-    async run() {
-        const { argv, flags } = await this.parse(Stop);
-        const log = (await getPlebbitLogger())("plebbit-cli:commands:subplebbit:stop");
-        log(`addresses: `, argv);
-        log(`flags: `, flags);
-        const addresses = argv;
-        if (!Array.isArray(addresses))
-            this.error(`Failed to parse addresses correctly (${addresses})`);
-        const plebbit = await this._connectToPlebbitRpc(flags.plebbitRpcUrl.toString());
-        for (const address of addresses) {
-            try {
-                const sub = await plebbit.createSubplebbit({ address });
-                await sub.stop(); // should stop the original subplebbit instance from running
-                this.log(address);
-            }
-            catch (e) {
-                //@ts-expect-error
-                e.details = { ...e.details, address };
-                console.error(e);
-                await plebbit.destroy();
-                this.exit(1);
-            }
-        }
-        await plebbit.destroy();
-    }
-}

package/dist/seeder.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/seeder.js

@@ -1,83 +0,0 @@
-// import lodash from "lodash";
-// import Logger from "@plebbit/plebbit-logger";
-// import { Plebbit } from "@plebbit/plebbit-js/dist/node/plebbit";
-// import { BasePages } from "@plebbit/plebbit-js/dist/node/pages";
-// import { Comment } from "@plebbit/plebbit-js/dist/node/comment";
-// import assert from "assert";
-// //@ts-expect-error
-// import { CID } from "ipfs-http-client";
-// import { Subplebbit } from "@plebbit/plebbit-js/dist/node/subplebbit/subplebbit";
-export {};
-// async function _loadAllPages(pageCid: string, pagesInstance: BasePages): Promise<Comment[]> {
-//     const log = Logger("plebbit-cli:server:seed:_loadAllPages");
-//     try {
-//         let sortedCommentsPage = await pagesInstance.getPage(pageCid);
-//         let sortedComments: Comment[] = sortedCommentsPage.comments;
-//         while (sortedCommentsPage.nextCid) {
-//             sortedCommentsPage = await pagesInstance.getPage(sortedCommentsPage.nextCid);
-//             sortedComments = sortedComments.concat(sortedCommentsPage.comments);
-//         }
-//         return sortedComments;
-//     } catch (e) {
-//         log.error(`Failed to load page (${pageCid}) of sub (${pagesInstance._subplebbitAddress}) due to error:`, e);
-//         return [];
-//     }
-// }
-// const seededIpns: Record<string, { lastSeededAt?: number }> = {};
-// async function _seedSub(sub: Subplebbit, pinnedCids: string[]) {
-//     const log = Logger("plebbit-cli:server:seed");
-//     if (sub.statsCid) await sub.plebbit.fetchCid(sub.statsCid); // Seed stats
-//     await sub.plebbit.pubsubSubscribe(sub.pubsubTopic || sub.address);
-//     // Load all pages
-//     if (sub.posts.pageCids) {
-//         const pagesLoaded = await Promise.all(Object.values(sub.posts.pageCids).map((pageCid) => _loadAllPages(pageCid, sub.posts)));
-//         // What if one of pages fail to load
-//         log.trace(`Loaded the newest pages of sub (${sub.address}) to seed`);
-//         const pageNames = Object.keys(sub.posts.pageCids);
-//         const loadedPagesWithNames = lodash.zipObject(pageNames, pagesLoaded);
-//         const allCidsToPin: string[] = [];
-//         if (loadedPagesWithNames["new"]) {
-//             // Fetch all comments CID
-//             allCidsToPin.push(...loadedPagesWithNames["new"].map((comment) => <string>comment.cid));
-//             // Seed IPNS
-//             for (const comment of loadedPagesWithNames["new"]) {
-//                 assert(comment.ipnsName);
-//                 if (seededIpns[comment.ipnsName]?.lastSeededAt !== comment.updatedAt) {
-//                     try {
-//                         await comment._clientsManager.fetchCommentUpdate(comment.ipnsName);
-//                         seededIpns[comment.ipnsName] = { lastSeededAt: comment.updatedAt };
-//                         log.trace(`Seeded comment (${comment.cid}) IPNS (${comment.ipnsName})`);
-//                     } catch (e) {
-//                         log.error(`Failed to seed comment (${comment.cid}) IPNS (${comment.ipnsName}) due to error`, e);
-//                     }
-//                 }
-//             }
-//         }
-//         // Pin cids that are not already pinned
-//         const newCidsToPin = lodash.difference(lodash.uniq(allCidsToPin), pinnedCids).map((cidString) => CID.parse(cidString));
-//         if (newCidsToPin.length > 0) {
-//             log.trace(`Attempting to pin ${newCidsToPin.length} comments' cids from sub (${sub.address}): `, newCidsToPin);
-//             const defaultIpfsClient = Object.values(sub.plebbit.clients.ipfsClients)[0];
-//             assert(defaultIpfsClient);
-//             await defaultIpfsClient._client.pin.addAll(newCidsToPin);
-//             log.trace(`Pinned ${newCidsToPin.length} cids from sub (${sub.address})`);
-//         } else log.trace(`All ${lodash.uniq(allCidsToPin).length} cids from sub (${sub.address}) are pinned`);
-//     }
-// }
-// export async function seedSubplebbits(subAddresses: string[], plebbit: Plebbit) {
-//     const log = Logger("plebbit-cli:server:seed");
-//     log.trace("test"); // remove this line later
-//     for (const subAddress of subAddresses) {
-//         try {
-//             const sub = await plebbit.getSubplebbit(subAddress);
-//             log.trace(`Loaded the newest record of sub (${subAddress}) for seeding`);
-//             const defaultIpfsClient = Object.values(sub.plebbit.clients.ipfsClients)[0];
-//             assert(defaultIpfsClient);
-//             const pinnedCids: string[] = (await defaultIpfsClient._client.pin.ls()).map((pin) => pin.cid.toString());
-//             await _seedSub(sub, pinnedCids);
-//         } catch (e) {
-//             log.error(`Failed to load and seed sub (${subAddress}):`, String(e));
-//         }
-//     }
-//     log(`Finished this round of seeding. Will seed again later`);
-// }