@pkcprotocol/pkc-js 0.0.11

package/dist/browser/pkc/pkc-client-manager.d.ts

@@ -0,0 +1,44 @@
+import { PKC } from "./pkc.js";
+import { NameResolverClient } from "../clients/name-resolver-client.js";
+import { BaseClientsManager, OptionsToLoadFromGateway, PreResolveNameResolverOptions, PostResolveNameResolverSuccessOptions, PostResolveNameResolverFailureOptions } from "../clients/base-client-manager.js";
+import { PKCIpfsGatewayClient, PKCKuboRpcClient, PKCLibp2pJsClient } from "./pkc-clients.js";
+import { GenericStateClient } from "../generic-state-client.js";
+export declare class PKCClientsManager extends BaseClientsManager {
+    clients: {
+        ipfsGateways: {
+            [ipfsGatewayUrl: string]: PKCIpfsGatewayClient;
+        };
+        kuboRpcClients: {
+            [kuboRpcClientUrl: string]: PKCKuboRpcClient;
+        };
+        pubsubKuboRpcClients: {
+            [pubsubKuboClientUrl: string]: GenericStateClient<string>;
+        };
+        libp2pJsClients: {
+            [libp2pJsClientKey: string]: PKCLibp2pJsClient;
+        };
+        nameResolvers: {
+            [resolverKey: string]: NameResolverClient;
+        };
+    };
+    constructor(pkc: PKC);
+    protected _initIpfsGateways(): void;
+    protected _initKuboRpcClients(): void;
+    protected _initPubsubKuboRpcClients(): void;
+    protected _initLibp2pJsClients(): void;
+    protected _initNameResolvers(): void;
+    preFetchGateway(gatewayUrl: string, loadOpts: OptionsToLoadFromGateway): void;
+    postFetchGatewayFailure(gatewayUrl: string, loadOpts: OptionsToLoadFromGateway): void;
+    postFetchGatewaySuccess(gatewayUrl: string, loadOpts: OptionsToLoadFromGateway): void;
+    postFetchGatewayAborted(gatewayUrl: string, loadOpts: OptionsToLoadFromGateway): void;
+    preResolveNameResolver({ resolveType, resolverKey }: PreResolveNameResolverOptions): void;
+    postResolveNameResolverSuccess({ resolverKey }: PostResolveNameResolverSuccessOptions): void;
+    postResolveNameResolverFailure({ resolverKey }: PostResolveNameResolverFailureOptions): void;
+    updateKuboRpcPubsubState(newState: PKCClientsManager["clients"]["pubsubKuboRpcClients"][string]["state"], pubsubProvider: string): void;
+    updateKuboRpcState(newState: PKCClientsManager["clients"]["kuboRpcClients"][string]["state"], kuboRpcClientUrl: string): void;
+    updateLibp2pJsClientState(newState: PKCClientsManager["clients"]["libp2pJsClients"][string]["state"], libp2pJsClientKey: string): void;
+    updateGatewayState(newState: PKCClientsManager["clients"]["ipfsGateways"][string]["state"], gateway: string): void;
+    updateNameResolverState(newState: NameResolverClient["state"], resolverKey: string): void;
+    fetchCid(cid: string): Promise<string>;
+    protected _getStatePriorToResolvingCommunityIpns(): "fetching-community-ipns" | "fetching-ipns";
+}

package/dist/browser/pkc/pkc-client-manager.js

@@ -0,0 +1,156 @@
+import { hideClassPrivateProps, isIpfsCid, isIpfsPath } from "../util.js";
+import { PKCError } from "../pkc-error.js";
+import assert from "assert";
+import * as remeda from "remeda";
+import { NameResolverClient } from "../clients/name-resolver-client.js";
+import { BaseClientsManager } from "../clients/base-client-manager.js";
+import Logger from "../logger.js";
+import { PKCIpfsGatewayClient, PKCKuboRpcClient, PKCLibp2pJsClient } from "./pkc-clients.js";
+import { GenericStateClient } from "../generic-state-client.js";
+export class PKCClientsManager extends BaseClientsManager {
+    constructor(pkc) {
+        super(pkc);
+        this._pkc = pkc;
+        //@ts-expect-error
+        this.clients = {};
+        this._initIpfsGateways();
+        this._initKuboRpcClients();
+        this._initPubsubKuboRpcClients();
+        this._initLibp2pJsClients();
+        this._initNameResolvers();
+        hideClassPrivateProps(this);
+    }
+    _initIpfsGateways() {
+        this.clients.ipfsGateways = {};
+        for (const gatewayUrl of remeda.keys.strict(this._pkc.clients.ipfsGateways))
+            this.clients.ipfsGateways = { ...this.clients.ipfsGateways, [gatewayUrl]: new PKCIpfsGatewayClient("stopped") };
+    }
+    _initKuboRpcClients() {
+        this.clients.kuboRpcClients = {};
+        for (const kuboRpcUrl of remeda.keys.strict(this._pkc.clients.kuboRpcClients))
+            this.clients.kuboRpcClients = { ...this.clients.kuboRpcClients, [kuboRpcUrl]: new PKCKuboRpcClient("stopped") };
+    }
+    _initPubsubKuboRpcClients() {
+        this.clients.pubsubKuboRpcClients = {};
+        for (const pubsubUrl of remeda.keys.strict(this._pkc.clients.pubsubKuboRpcClients))
+            this.clients.pubsubKuboRpcClients = {
+                ...this.clients.pubsubKuboRpcClients,
+                [pubsubUrl]: new GenericStateClient("stopped")
+            };
+    }
+    _initLibp2pJsClients() {
+        this.clients.libp2pJsClients = {};
+        for (const libp2pJsClientKey of remeda.keys.strict(this._pkc.clients.libp2pJsClients))
+            this.clients.libp2pJsClients = { ...this.clients.libp2pJsClients, [libp2pJsClientKey]: new PKCLibp2pJsClient("stopped") };
+    }
+    _initNameResolvers() {
+        this.clients.nameResolvers = {};
+        if (this._pkc.nameResolvers) {
+            for (const resolver of this._pkc.nameResolvers) {
+                this.clients.nameResolvers[resolver.key] = new NameResolverClient("stopped");
+            }
+        }
+    }
+    // Overriding functions from base client manager here
+    preFetchGateway(gatewayUrl, loadOpts) {
+        const gatewayState = loadOpts.recordPKCType === "community"
+            ? this._getStatePriorToResolvingCommunityIpns()
+            : loadOpts.recordPKCType === "comment-update"
+                ? "fetching-update-ipfs"
+                : loadOpts.recordPKCType === "comment" ||
+                    loadOpts.recordPKCType === "generic-ipfs" ||
+                    loadOpts.recordPKCType === "page-ipfs"
+                    ? "fetching-ipfs"
+                    : undefined;
+        assert(gatewayState, "unable to compute the new gateway state");
+        this.updateGatewayState(gatewayState, gatewayUrl);
+    }
+    postFetchGatewayFailure(gatewayUrl, loadOpts) {
+        this.updateGatewayState("stopped", gatewayUrl);
+    }
+    postFetchGatewaySuccess(gatewayUrl, loadOpts) {
+        this.updateGatewayState("stopped", gatewayUrl);
+    }
+    postFetchGatewayAborted(gatewayUrl, loadOpts) {
+        this.postFetchGatewaySuccess(gatewayUrl, loadOpts);
+    }
+    preResolveNameResolver({ resolveType, resolverKey }) {
+        const newState = resolveType === "community" ? "resolving-community-name" : "resolving-author-name";
+        this.updateNameResolverState(newState, resolverKey);
+    }
+    postResolveNameResolverSuccess({ resolverKey }) {
+        this.updateNameResolverState("stopped", resolverKey);
+    }
+    postResolveNameResolverFailure({ resolverKey }) {
+        this.updateNameResolverState("stopped", resolverKey);
+    }
+    // State methods here
+    updateKuboRpcPubsubState(newState, pubsubProvider) {
+        assert(typeof pubsubProvider === "string", "Can't update pubsub state to undefined");
+        assert(typeof newState === "string", "Can't update pubsub state to undefined");
+        if (this.clients.pubsubKuboRpcClients[pubsubProvider].state === newState)
+            return;
+        this.clients.pubsubKuboRpcClients[pubsubProvider].state = newState;
+        this.clients.pubsubKuboRpcClients[pubsubProvider].emit("statechange", newState);
+    }
+    updateKuboRpcState(newState, kuboRpcClientUrl) {
+        assert(typeof newState === "string", "Can't update ipfs state to undefined");
+        assert(typeof kuboRpcClientUrl === "string", "Can't update ipfs state to undefined");
+        if (this.clients.kuboRpcClients[kuboRpcClientUrl].state === newState)
+            return;
+        this.clients.kuboRpcClients[kuboRpcClientUrl].state = newState;
+        this.clients.kuboRpcClients[kuboRpcClientUrl].emit("statechange", newState);
+    }
+    updateLibp2pJsClientState(newState, libp2pJsClientKey) {
+        assert(typeof newState === "string", "Can't update libp2p js client state to undefined");
+        assert(typeof libp2pJsClientKey === "string", "Can't update libp2p js client state to undefined");
+        if (this.clients.libp2pJsClients[libp2pJsClientKey].state === newState)
+            return;
+        this.clients.libp2pJsClients[libp2pJsClientKey].state = newState;
+        this.clients.libp2pJsClients[libp2pJsClientKey].emit("statechange", newState);
+    }
+    updateGatewayState(newState, gateway) {
+        assert(typeof newState === "string", "Can't update gateway state to undefined");
+        if (this.clients.ipfsGateways[gateway].state === newState)
+            return;
+        this.clients.ipfsGateways[gateway].state = newState;
+        this.clients.ipfsGateways[gateway].emit("statechange", newState);
+    }
+    updateNameResolverState(newState, resolverKey) {
+        assert(typeof newState === "string", "Can't update name resolver state to undefined");
+        if (!this.clients.nameResolvers[resolverKey])
+            return;
+        if (this.clients.nameResolvers[resolverKey].state === newState)
+            return;
+        this.clients.nameResolvers[resolverKey].state = newState;
+        this.clients.nameResolvers[resolverKey].emit("statechange", newState);
+    }
+    async fetchCid(cid) {
+        let finalCid = remeda.clone(cid);
+        if (!isIpfsCid(finalCid) && isIpfsPath(finalCid))
+            finalCid = finalCid.split("/")[2];
+        if (!isIpfsCid(finalCid))
+            throw new PKCError("ERR_CID_IS_INVALID", { cid });
+        const timeoutMs = this._pkc._timeouts["generic-ipfs"];
+        if (Object.keys(this.clients.kuboRpcClients).length > 0 || Object.keys(this.clients.libp2pJsClients).length > 0)
+            return this._fetchCidP2P(cid, { maxFileSizeBytes: 1024 * 1024, timeoutMs });
+        else {
+            const log = Logger("pkc-js:clients-manager:fetchCid");
+            const resObj = await this.fetchFromMultipleGateways({
+                root: cid,
+                recordIpfsType: "ipfs",
+                recordPKCType: "generic-ipfs",
+                validateGatewayResponseFunc: async () => { }, // no need to validate body against cid here, fetchFromMultipleGateways already does it
+                log,
+                maxFileSizeBytes: 1024 * 1024,
+                timeoutMs
+            });
+            return resObj.resText;
+        }
+    }
+    // fetchCommunity should be here
+    _getStatePriorToResolvingCommunityIpns() {
+        return "fetching-community-ipns";
+    }
+}
+//# sourceMappingURL=pkc-client-manager.js.map

package/dist/browser/pkc/pkc-client-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pkc-client-manager.js","sourceRoot":"","sources":["../../../src/pkc/pkc-client-manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAExE,OAAO,EACH,kBAAkB,EAKrB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,MAAM,MAAM,cAAc,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC7F,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAEhE,MAAM,OAAO,iBAAkB,SAAQ,kBAAkB;IASrD,YAAY,GAAQ;QAChB,KAAK,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,kBAAkB;QAClB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC,yBAAyB,EAAE,CAAC;QACjC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAES,iBAAiB;QACvB,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,EAAE,CAAC;QAC/B,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;YACvE,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,CAAC,EAAE,IAAI,oBAAoB,CAAC,SAAS,CAAC,EAAE,CAAC;IACxH,CAAC;IAES,mBAAmB;QACzB,IAAI,CAAC,OAAO,CAAC,cAAc,GAAG,EAAE,CAAC;QACjC,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;YACzE,IAAI,CAAC,OAAO,CAAC,cAAc,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,UAAU,CAAC,EAAE,IAAI,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC;IACxH,CAAC;IAES,yBAAyB;QAC/B,IAAI,CAAC,OAAO,CAAC,oBAAoB,GAAG,EAAE,CAAC;QACvC,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC;YAC9E,IAAI,CAAC,OAAO,CAAC,oBAAoB,GAAG;gBAChC,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB;gBACpC,CAAC,SAAS,CAAC,EAAE,IAAI,kBAAkB,CAAS,SAAS,CAAC;aACzD,CAAC;IACV,CAAC;IAES,oBAAoB;QAC1B,IAAI,CAAC,OAAO,CAAC,eAAe,GAAG,EAAE,CAAC;QAClC,KAAK,MAAM,iBAAiB,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;YACjF,IAAI,CAAC,OAAO,CAAC,eAAe,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,iBAAiB,CAAC,EAAE,IAAI,iBAAiB,CAAC,SAAS,CAAC,EAAE,CAAC;IAClI,CAAC;IAES,kBAAkB;QACxB,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,EAAE,CAAC;QAChC,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YAC1B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC7C,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;YACjF,CAAC;QACL,CAAC;IACL,CAAC;IAED,qDAAqD;IAE5C,eAAe,CAAC,UAAkB,EAAE,QAAkC;QAC3E,MAAM,YAAY,GACd,QAAQ,CAAC,aAAa,KAAK,WAAW;YAClC,CAAC,CAAC,IAAI,CAAC,sCAAsC,EAAE;YAC/C,CAAC,CAAC,QAAQ,CAAC,aAAa,KAAK,gBAAgB;gBAC3C,CAAC,CAAC,sBAAsB;gBACxB,CAAC,CAAC,QAAQ,CAAC,aAAa,KAAK,SAAS;oBAClC,QAAQ,CAAC,aAAa,KAAK,cAAc;oBACzC,QAAQ,CAAC,aAAa,KAAK,WAAW;oBACxC,CAAC,CAAC,eAAe;oBACjB,CAAC,CAAC,SAAS,CAAC;QACxB,MAAM,CAAC,YAAY,EAAE,yCAAyC,CAAC,CAAC;QAChE,IAAI,CAAC,kBAAkB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACtD,CAAC;IAEQ,uBAAuB,CAAC,UAAkB,EAAE,QAAkC;QACnF,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACnD,CAAC;IAEQ,uBAAuB,CAAC,UAAkB,EAAE,QAAkC;QACnF,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACnD,CAAC;IAEQ,uBAAuB,CAAC,UAAkB,EAAE,QAAkC;QACnF,IAAI,CAAC,uBAAuB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IAEQ,sBAAsB,CAAC,EAAE,WAAW,EAAE,WAAW,EAAiC;QACvF,MAAM,QAAQ,GAAG,WAAW,KAAK,WAAW,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,uBAAuB,CAAC;QACpG,IAAI,CAAC,uBAAuB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAEQ,8BAA8B,CAAC,EAAE,WAAW,EAAyC;QAC1F,IAAI,CAAC,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IAEQ,8BAA8B,CAAC,EAAE,WAAW,EAAyC;QAC1F,IAAI,CAAC,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IAED,qBAAqB;IAErB,wBAAwB,CAAC,QAA+E,EAAE,cAAsB;QAC5H,MAAM,CAAC,OAAO,cAAc,KAAK,QAAQ,EAAE,wCAAwC,CAAC,CAAC;QACrF,MAAM,CAAC,OAAO,QAAQ,KAAK,QAAQ,EAAE,wCAAwC,CAAC,CAAC;QAC/E,IAAI,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC,KAAK,KAAK,QAAQ;YAAE,OAAO;QACjF,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC,KAAK,GAAG,QAAQ,CAAC;QACnE,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACpF,CAAC;IAED,kBAAkB,CAAC,QAAyE,EAAE,gBAAwB;QAClH,MAAM,CAAC,OAAO,QAAQ,KAAK,QAAQ,EAAE,sCAAsC,CAAC,CAAC;QAC7E,MAAM,CAAC,OAAO,gBAAgB,KAAK,QAAQ,EAAE,sCAAsC,CAAC,CAAC;QACrF,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,KAAK,KAAK,QAAQ;YAAE,OAAO;QAC7E,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,KAAK,GAAG,QAAQ,CAAC;QAC/D,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IAChF,CAAC;IAED,yBAAyB,CAAC,QAA0E,EAAE,iBAAyB;QAC3H,MAAM,CAAC,OAAO,QAAQ,KAAK,QAAQ,EAAE,kDAAkD,CAAC,CAAC;QACzF,MAAM,CAAC,OAAO,iBAAiB,KAAK,QAAQ,EAAE,kDAAkD,CAAC,CAAC;QAClG,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,KAAK,KAAK,QAAQ;YAAE,OAAO;QAC/E,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,KAAK,GAAG,QAAQ,CAAC;QACjE,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IAClF,CAAC;IAED,kBAAkB,CAAC,QAAuE,EAAE,OAAe;QACvG,MAAM,CAAC,OAAO,QAAQ,KAAK,QAAQ,EAAE,yCAAyC,CAAC,CAAC;QAChF,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ;YAAE,OAAO;QAClE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,QAAQ,CAAC;QACpD,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACrE,CAAC;IAED,uBAAuB,CAAC,QAAqC,EAAE,WAAmB;QAC9E,MAAM,CAAC,OAAO,QAAQ,KAAK,QAAQ,EAAE,+CAA+C,CAAC,CAAC;QACtF,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC;YAAE,OAAO;QACrD,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,KAAK,KAAK,QAAQ;YAAE,OAAO;QACvE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,KAAK,GAAG,QAAQ,CAAC;QACzD,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAW;QACtB,IAAI,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC;YAAE,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACpF,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,QAAQ,CAAC,oBAAoB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QAC5E,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QACtD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC;YAC3G,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,EAAE,gBAAgB,EAAE,IAAI,GAAG,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;aAC3E,CAAC;YACF,MAAM,GAAG,GAAG,MAAM,CAAC,iCAAiC,CAAC,CAAC;YACtD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC;gBAChD,IAAI,EAAE,GAAG;gBACT,cAAc,EAAE,MAAM;gBACtB,aAAa,EAAE,cAAc;gBAC7B,2BAA2B,EAAE,KAAK,IAAI,EAAE,GAAE,CAAC,EAAE,uFAAuF;gBACpI,GAAG;gBACH,gBAAgB,EAAE,IAAI,GAAG,IAAI;gBAC7B,SAAS;aACZ,CAAC,CAAC;YACH,OAAO,MAAM,CAAC,OAAO,CAAC;QAC1B,CAAC;IACL,CAAC;IAED,gCAAgC;IAEtB,sCAAsC;QAC5C,OAAO,yBAAyB,CAAC;IACrC,CAAC;CACJ"}

package/dist/browser/pkc/pkc-clients.d.ts

@@ -0,0 +1,11 @@
+import { GenericStateClient } from "../generic-state-client.js";
+type PKCIpfsGatewayState = "fetching-ipfs" | "stopped";
+type PKCKuboRpcState = "fetching-ipfs" | "stopped";
+type PKCLibp2pJsState = "fetching-ipfs" | "stopped";
+export declare class PKCIpfsGatewayClient extends GenericStateClient<PKCIpfsGatewayState | string> {
+}
+export declare class PKCKuboRpcClient extends GenericStateClient<PKCKuboRpcState | string> {
+}
+export declare class PKCLibp2pJsClient extends GenericStateClient<PKCLibp2pJsState | string> {
+}
+export {};

package/dist/browser/pkc/pkc-clients.js

@@ -0,0 +1,8 @@
+import { GenericStateClient } from "../generic-state-client.js";
+export class PKCIpfsGatewayClient extends GenericStateClient {
+}
+export class PKCKuboRpcClient extends GenericStateClient {
+}
+export class PKCLibp2pJsClient extends GenericStateClient {
+}
+//# sourceMappingURL=pkc-clients.js.map

package/dist/browser/pkc/pkc-clients.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pkc-clients.js","sourceRoot":"","sources":["../../../src/pkc/pkc-clients.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAQhE,MAAM,OAAO,oBAAqB,SAAQ,kBAAgD;CAAG;AAE7F,MAAM,OAAO,gBAAiB,SAAQ,kBAA4C;CAAG;AAErF,MAAM,OAAO,iBAAkB,SAAQ,kBAA6C;CAAG"}

package/dist/browser/pkc/pkc-with-rpc-client.d.ts

@@ -0,0 +1,19 @@
+import { PKC } from "./pkc.js";
+import type { InputPKCOptions } from "../types.js";
+import { CreateRpcCommunityFunctionArgumentSchema } from "../community/schema.js";
+import { RpcLocalCommunity } from "../community/rpc-local-community.js";
+import { RpcRemoteCommunity } from "../community/rpc-remote-community.js";
+import type { RpcLocalCommunityJson, RpcRemoteCommunityJson } from "../community/types.js";
+import { z } from "zod";
+import type { AuthorNameRpcParam, CidRpcParam } from "../clients/rpc-client/types.js";
+export declare class PKCWithRpcClient extends PKC {
+    _pkcRpcClient: NonNullable<PKC["_pkcRpcClient"]>;
+    pkcRpcClientsOptions: NonNullable<PKC["pkcRpcClientsOptions"]>;
+    constructor(options: InputPKCOptions);
+    _init(): Promise<void>;
+    fetchCid(cid: CidRpcParam): Promise<string>;
+    resolveAuthorName(args: AuthorNameRpcParam): Promise<string | null>;
+    destroy(): Promise<void>;
+    getComment(commentCid: CidRpcParam): Promise<import("../publications/comment/comment.js").Comment>;
+    createCommunity(options?: z.infer<typeof CreateRpcCommunityFunctionArgumentSchema> | RpcRemoteCommunityJson | RpcLocalCommunityJson): Promise<RpcLocalCommunity | RpcRemoteCommunity>;
+}

package/dist/browser/pkc/pkc-with-rpc-client.js

@@ -0,0 +1,128 @@
+import Logger from "../logger.js";
+import { PKC } from "./pkc.js";
+import { parseCreateRpcCommunityFunctionArgumentSchemaWithPKCErrorIfItFails } from "../schema/schema-util.js";
+import { RpcLocalCommunity } from "../community/rpc-local-community.js";
+import { RpcRemoteCommunity } from "../community/rpc-remote-community.js";
+import { parseRpcAuthorNameParam, parseRpcCidParam } from "../clients/rpc-client/rpc-schema-util.js";
+import { listStartedCommunities } from "./tracked-instance-registry-util.js";
+// This is a helper class for separating RPC-client logic from main PKC
+// Not meant to be used with end users
+export class PKCWithRpcClient extends PKC {
+    constructor(options) {
+        super(options);
+        this._pkcRpcClient = this.clients.pkcRpcClients[Object.keys(this.clients.pkcRpcClients)[0]]; // will change later once we start supporting multiple RPCs
+    }
+    async _init() {
+        await super._init();
+        const log = Logger("pkc-js:pkc-with-rpc-client:_init");
+        this.communities = [];
+        this._pkcRpcClient.on("communitieschange", (newSubs) => this.emit("communitieschange", newSubs));
+        for (const rpcUrl of Object.keys(this.clients.pkcRpcClients)) {
+            const rpcClient = this.clients.pkcRpcClients[rpcUrl];
+            rpcClient.on("error", (err) => this.emit("error", err));
+            rpcClient.initalizeCommunitieschangeEvent().catch((err) => {
+                log.error("Failed to initialize RPC", rpcUrl, "communitieschange event", err);
+            });
+            rpcClient.initalizeSettingschangeEvent().catch((err) => {
+                log.error("Failed to initialize RPC", rpcUrl, "settingschange event", err);
+            });
+        }
+        // TODO merge different pkcRpcClient.communities
+        this._pkcRpcClient.on("settingschange", (newSettings) => {
+            this.emit("settingschange", newSettings.pkcOptions);
+        });
+    }
+    async fetchCid(cid) {
+        const parsedCid = parseRpcCidParam(cid).cid;
+        return this._pkcRpcClient.fetchCid({ cid: parsedCid });
+    }
+    async resolveAuthorName(args) {
+        const parsedArgs = parseRpcAuthorNameParam(args);
+        return this._pkcRpcClient.resolveAuthorName(parsedArgs);
+    }
+    async destroy() {
+        for (const startedCommunity of listStartedCommunities(this)) {
+            await startedCommunity.stopWithoutRpcCall();
+        }
+        await super.destroy();
+        await this._pkcRpcClient.destroy();
+    }
+    async getComment(commentCid) {
+        const parsedArgs = parseRpcCidParam(commentCid);
+        const commentIpfs = await this._pkcRpcClient.getComment(parsedArgs);
+        return this.createComment({ raw: { comment: commentIpfs }, cid: parsedArgs.cid });
+    }
+    async createCommunity(options = {}) {
+        const log = Logger("pkc-js:pkc-with-rpc-client:createCommunity");
+        // No need to parse if it's a jsonified instance
+        const parsedRpcOptions = "clients" in options ? options : parseCreateRpcCommunityFunctionArgumentSchemaWithPKCErrorIfItFails(options);
+        log.trace("Received community options to create a community instance over RPC:", options);
+        const hasIdentifier = ("address" in parsedRpcOptions && typeof parsedRpcOptions.address === "string") ||
+            ("name" in parsedRpcOptions && typeof parsedRpcOptions.name === "string") ||
+            ("publicKey" in parsedRpcOptions && typeof parsedRpcOptions.publicKey === "string");
+        const effectiveAddress = parsedRpcOptions.address ||
+            parsedRpcOptions.name ||
+            parsedRpcOptions.publicKey;
+        if (hasIdentifier && effectiveAddress) {
+            await this._waitForCommunitiesToBeDefined();
+            const rpcCommunities = this.communities; // should probably be replaced with a direct call for communities
+            const isCommunityRpcLocal = rpcCommunities.includes(effectiveAddress);
+            if ("clients" in options && isCommunityRpcLocal) {
+                // Jsonified local community — rehydrate from raw.localCommunity instead of doing a fresh RPC fetch
+                const community = new RpcLocalCommunity(this);
+                const jsonified = parsedRpcOptions;
+                const rawRecord = jsonified.raw?.localCommunity;
+                if (rawRecord) {
+                    if ("community" in rawRecord)
+                        community.initRpcInternalCommunityAfterFirstUpdateNoMerge(rawRecord);
+                    else
+                        community.initRpcInternalCommunityBeforeFirstUpdateNoMerge(rawRecord);
+                }
+                if (jsonified.raw)
+                    Object.assign(community.raw, jsonified.raw);
+                return community;
+            }
+            else if (isCommunityRpcLocal) {
+                // No jsonified data — do a fresh fetch
+                const community = new RpcLocalCommunity(this);
+                community.setAddress(effectiveAddress);
+                // wait for one update here, and then stop
+                const updatePromise = new Promise((resolve) => community.once("update", resolve));
+                let error;
+                const errorPromise = new Promise((resolve) => community.once("error", (err) => resolve((error = err))));
+                await community._createAndSubscribeToNewUpdatingCommunity(community);
+                await community.update();
+                await Promise.race([updatePromise, errorPromise]);
+                await community.stop();
+                if (error)
+                    throw error;
+                return community;
+            }
+            else {
+                log.trace("Creating a remote RPC community instance with address", effectiveAddress);
+                const remoteCommunity = new RpcRemoteCommunity(this);
+                await this._setCommunityIpfsOnInstanceIfPossible(remoteCommunity, parsedRpcOptions);
+                return remoteCommunity;
+            }
+        }
+        else if (!hasIdentifier) {
+            // Check if this looks like a CommunityIpfs record — handle as remote community init
+            if ("signature" in parsedRpcOptions) {
+                const remoteCommunity = new RpcRemoteCommunity(this);
+                await this._setCommunityIpfsOnInstanceIfPossible(remoteCommunity, parsedRpcOptions);
+                return remoteCommunity;
+            }
+            // We're creating a new local community
+            const communityPropsAfterCreation = await this._pkcRpcClient.createCommunity(parsedRpcOptions);
+            log(`Created new local-RPC community (${communityPropsAfterCreation.localCommunity.address}) with props:`, JSON.parse(JSON.stringify(communityPropsAfterCreation)));
+            const community = new RpcLocalCommunity(this);
+            await community.initRpcInternalCommunityBeforeFirstUpdateNoMerge(communityPropsAfterCreation);
+            community.emit("update", community);
+            await this._awaitCommunitiesToIncludeCommunity(communityPropsAfterCreation.localCommunity.address);
+            return community;
+        }
+        else
+            throw Error("Failed to create community rpc instance, are you sure you provided the correct args?");
+    }
+}
+//# sourceMappingURL=pkc-with-rpc-client.js.map

package/dist/browser/pkc/pkc-with-rpc-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pkc-with-rpc-client.js","sourceRoot":"","sources":["../../../src/pkc/pkc-with-rpc-client.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,cAAc,CAAC;AAClC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B,OAAO,EAAE,kEAAkE,EAAE,MAAM,0BAA0B,CAAC;AAE9G,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAK1E,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AACrG,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAE7E,uEAAuE;AACvE,sCAAsC;AACtC,MAAM,OAAO,gBAAiB,SAAQ,GAAG;IAIrC,YAAY,OAAwB;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,2DAA2D;IAC5J,CAAC;IAEQ,KAAK,CAAC,KAAK;QAChB,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QACpB,MAAM,GAAG,GAAG,MAAM,CAAC,kCAAkC,CAAC,CAAC;QAEvD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QAEtB,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,CAAC;QAEjG,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YAC3D,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YACrD,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;YACxD,SAAS,CAAC,+BAA+B,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACtD,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,MAAM,EAAE,yBAAyB,EAAE,GAAG,CAAC,CAAC;YAClF,CAAC,CAAC,CAAC;YACH,SAAS,CAAC,4BAA4B,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACnD,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,MAAM,EAAE,sBAAsB,EAAE,GAAG,CAAC,CAAC;YAC/E,CAAC,CAAC,CAAC;QACP,CAAC;QACD,gDAAgD;QAEhD,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,WAAW,EAAE,EAAE;YACpD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACP,CAAC;IAEQ,KAAK,CAAC,QAAQ,CAAC,GAAgB;QACpC,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;QAC5C,OAAO,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;IAC3D,CAAC;IAEQ,KAAK,CAAC,iBAAiB,CAAC,IAAwB;QACrD,MAAM,UAAU,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAC5D,CAAC;IAEQ,KAAK,CAAC,OAAO;QAClB,KAAK,MAAM,gBAAgB,IAAI,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1D,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;QAChD,CAAC;QACD,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;QACtB,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;IACvC,CAAC;IAEQ,KAAK,CAAC,UAAU,CAAC,UAAuB;QAC7C,MAAM,UAAU,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAEhD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC;IACtF,CAAC;IAEQ,KAAK,CAAC,eAAe,CAC1B,UAAqH,EAAE;QAEvH,MAAM,GAAG,GAAG,MAAM,CAAC,4CAA4C,CAAC,CAAC;QAEjE,gDAAgD;QAChD,MAAM,gBAAgB,GAClB,SAAS,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,kEAAkE,CAAC,OAAO,CAAC,CAAC;QAEjH,GAAG,CAAC,KAAK,CAAC,qEAAqE,EAAE,OAAO,CAAC,CAAC;QAE1F,MAAM,aAAa,GACf,CAAC,SAAS,IAAI,gBAAgB,IAAI,OAAO,gBAAgB,CAAC,OAAO,KAAK,QAAQ,CAAC;YAC/E,CAAC,MAAM,IAAI,gBAAgB,IAAI,OAAO,gBAAgB,CAAC,IAAI,KAAK,QAAQ,CAAC;YACzE,CAAC,WAAW,IAAI,gBAAgB,IAAI,OAAO,gBAAgB,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC;QACxF,MAAM,gBAAgB,GAChB,gBAA4C,CAAC,OAA8B;YAC3E,gBAA4C,CAAC,IAA2B;YACxE,gBAA4C,CAAC,SAAgC,CAAC;QAEpF,IAAI,aAAa,IAAI,gBAAgB,EAAE,CAAC;YACpC,MAAM,IAAI,CAAC,8BAA8B,EAAE,CAAC;YAC5C,MAAM,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,iEAAiE;YAC1G,MAAM,mBAAmB,GAAG,cAAc,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YAEtE,IAAI,SAAS,IAAI,OAAO,IAAI,mBAAmB,EAAE,CAAC;gBAC9C,mGAAmG;gBACnG,MAAM,SAAS,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBAC9C,MAAM,SAAS,GAAG,gBAAoD,CAAC;gBACvE,MAAM,SAAS,GAAI,SAAS,CAAC,GAA4C,EAAE,cAE5D,CAAC;gBAChB,IAAI,SAAS,EAAE,CAAC;oBACZ,IAAI,WAAW,IAAI,SAAS;wBAAE,SAAS,CAAC,+CAA+C,CAAC,SAAS,CAAC,CAAC;;wBAC9F,SAAS,CAAC,gDAAgD,CAAC,SAAS,CAAC,CAAC;gBAC/E,CAAC;gBACD,IAAI,SAAS,CAAC,GAAG;oBAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;gBAC/D,OAAO,SAAS,CAAC;YACrB,CAAC;iBAAM,IAAI,mBAAmB,EAAE,CAAC;gBAC7B,uCAAuC;gBACvC,MAAM,SAAS,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBAC9C,SAAS,CAAC,UAAU,CAAC,gBAAiB,CAAC,CAAC;gBACxC,0CAA0C;gBAC1C,MAAM,aAAa,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;gBAClF,IAAI,KAAmC,CAAC;gBACxC,MAAM,YAAY,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxG,MAAM,SAAS,CAAC,yCAAyC,CAAC,SAAS,CAAC,CAAC;gBACrE,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC;gBACzB,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC;gBAClD,MAAM,SAAS,CAAC,IAAI,EAAE,CAAC;gBACvB,IAAI,KAAK;oBAAE,MAAM,KAAK,CAAC;gBAEvB,OAAO,SAAS,CAAC;YACrB,CAAC;iBAAM,CAAC;gBACJ,GAAG,CAAC,KAAK,CAAC,uDAAuD,EAAE,gBAAgB,CAAC,CAAC;gBACrF,MAAM,eAAe,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;gBACrD,MAAM,IAAI,CAAC,qCAAqC,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;gBAEpF,OAAO,eAAe,CAAC;YAC3B,CAAC;QACL,CAAC;aAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,oFAAoF;YACpF,IAAI,WAAW,IAAI,gBAAgB,EAAE,CAAC;gBAClC,MAAM,eAAe,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;gBACrD,MAAM,IAAI,CAAC,qCAAqC,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;gBACpF,OAAO,eAAe,CAAC;YAC3B,CAAC;YACD,uCAAuC;YACvC,MAAM,2BAA2B,GAAG,MAAM,IAAI,CAAC,aAAc,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;YAChG,GAAG,CACC,oCAAoC,2BAA2B,CAAC,cAAc,CAAC,OAAO,eAAe,EACrG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC,CAC1D,CAAC;YACF,MAAM,SAAS,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAC9C,MAAM,SAAS,CAAC,gDAAgD,CAAC,2BAA2B,CAAC,CAAC;YAC9F,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACpC,MAAM,IAAI,CAAC,mCAAmC,CAAC,2BAA2B,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;YACnG,OAAO,SAAS,CAAC;QACrB,CAAC;;YAAM,MAAM,KAAK,CAAC,sFAAsF,CAAC,CAAC;IAC/G,CAAC;CACJ"}

package/dist/browser/pkc/pkc.d.ts

@@ -0,0 +1,137 @@
+import type { StorageInterface, GatewayClient, KuboRpcClient, PKCEvents, PubsubClient, ParsedPKCOptions, LRUStorageInterface, LRUStorageConstructor, InputPKCOptions, PKCMemCaches } from "../types.js";
+import { Comment } from "../publications/comment/comment.js";
+import Vote from "../publications/vote/vote.js";
+import { CommentEdit } from "../publications/comment-edit/comment-edit.js";
+import Stats from "../stats.js";
+import { PKCClientsManager } from "./pkc-client-manager.js";
+import PKCRpcClient from "../clients/rpc-client/pkc-rpc-client.js";
+import { InflightFetchManager } from "../util/inflight-fetch-manager.js";
+import type { ChallengeFileFactoryInput, CreateRemoteCommunityOptions, CommunityJson, CommunityIpfsType, RemoteCommunityJson, RpcRemoteCommunityJson } from "../community/types.js";
+import { RemoteCommunity } from "../community/remote-community.js";
+import { RpcRemoteCommunity } from "../community/rpc-remote-community.js";
+import { RpcLocalCommunity } from "../community/rpc-local-community.js";
+import { LocalCommunity } from "../runtime/browser/community/local-community.js";
+import { z } from "zod";
+import type { CreateSignerOptions } from "../signer/types.js";
+import type { CommentEditPubsubMessagePublication, CommentEditTypeJson, CreateCommentEditOptions } from "../publications/comment-edit/types.js";
+import type { CreateVoteOptions, VoteJson, VotePubsubMessagePublication } from "../publications/vote/types.js";
+import type { CommentIpfsType, CommentIpfsWithCidDefined, CommentJson, CommentPubsubMessagePublication, CommentUpdateType, CommentWithinRepliesPostsPageJson, CreateCommentOptions, MinimumCommentFieldsToFetchPages } from "../publications/comment/types.js";
+import { CreateCommunityFunctionArgumentsSchema } from "../community/schema.js";
+import { CommentModeration } from "../publications/comment-moderation/comment-moderation.js";
+import type { CommentModerationPubsubMessagePublication, CommentModerationTypeJson, CreateCommentModerationOptions } from "../publications/comment-moderation/types.js";
+import CommunityEdit from "../publications/community-edit/community-edit.js";
+import type { CreateCommunityEditPublicationOptions, CommunityEditJson, CommunityEditPubsubMessagePublication } from "../publications/community-edit/types.js";
+import { PKCTypedEmitter } from "../clients/pkc-typed-emitter.js";
+import type { PageTypeJson } from "../pages/types.js";
+import { Libp2pJsClient } from "../helia/libp2pjsClient.js";
+import { AuthorNameRpcParam, CidRpcParam, CommunityLookupRpcParam } from "../clients/rpc-client/types.js";
+import { IndexedTrackedInstanceRegistry } from "./tracked-instance-registry.js";
+export declare class PKC extends PKCTypedEmitter<PKCEvents> implements ParsedPKCOptions {
+    ipfsGatewayUrls: ParsedPKCOptions["ipfsGatewayUrls"];
+    kuboRpcClientsOptions?: ParsedPKCOptions["kuboRpcClientsOptions"];
+    pubsubKuboRpcClientsOptions: ParsedPKCOptions["pubsubKuboRpcClientsOptions"];
+    pkcRpcClientsOptions?: ParsedPKCOptions["pkcRpcClientsOptions"];
+    libp2pJsClientsOptions?: ParsedPKCOptions["libp2pJsClientsOptions"];
+    dataPath?: ParsedPKCOptions["dataPath"];
+    resolveAuthorNames: ParsedPKCOptions["resolveAuthorNames"];
+    nameResolvers?: ParsedPKCOptions["nameResolvers"];
+    parsedPKCOptions: ParsedPKCOptions;
+    publishInterval: ParsedPKCOptions["publishInterval"];
+    updateInterval: ParsedPKCOptions["updateInterval"];
+    noData: ParsedPKCOptions["noData"];
+    validatePages: ParsedPKCOptions["validatePages"];
+    userAgent: ParsedPKCOptions["userAgent"];
+    httpRoutersOptions: ParsedPKCOptions["httpRoutersOptions"];
+    clients: {
+        ipfsGateways: {
+            [ipfsGatewayUrl: NonNullable<ParsedPKCOptions["ipfsGatewayUrls"]>[number]]: GatewayClient;
+        };
+        kuboRpcClients: {
+            [kuboRpcClientUrl: string]: KuboRpcClient;
+        };
+        pubsubKuboRpcClients: {
+            [pubsubKuboClientUrl: string]: PubsubClient;
+        };
+        pkcRpcClients: {
+            [pkcRpcUrl: NonNullable<ParsedPKCOptions["pkcRpcClientsOptions"]>[number]]: PKCRpcClient;
+        };
+        libp2pJsClients: {
+            [libp2pJsClientKey: NonNullable<ParsedPKCOptions["libp2pJsClientsOptions"]>[number]["key"]]: Libp2pJsClient;
+        };
+    };
+    communities: string[];
+    settings: {
+        challenges?: Record<string, ChallengeFileFactoryInput>;
+    };
+    _pkcRpcClient?: PKCRpcClient;
+    private _pubsubSubscriptions;
+    _clientsManager: PKCClientsManager;
+    _userPKCOptions: InputPKCOptions;
+    _stats: Stats;
+    _storage: StorageInterface;
+    _updatingCommunities: IndexedTrackedInstanceRegistry<RemoteCommunity | RpcRemoteCommunity | RpcLocalCommunity | LocalCommunity>;
+    _updatingComments: IndexedTrackedInstanceRegistry<Comment>;
+    _startedCommunities: IndexedTrackedInstanceRegistry<LocalCommunity | RpcLocalCommunity>;
+    private _communityFsWatchAbort?;
+    private _addressRewriterDestroy?;
+    private _addressRewriterSetupPromise?;
+    destroyed: boolean;
+    private _promiseToWaitForFirstCommunitieschangeEvent;
+    private _storageLRUs;
+    _memCaches: PKCMemCaches;
+    _inflightFetchManager: InflightFetchManager;
+    _timeouts: {
+        "community-ipns": number;
+        "community-ipfs": number;
+        "comment-ipfs": number;
+        "comment-update-ipfs": number;
+        "page-ipfs": number;
+        "generic-ipfs": number;
+    };
+    constructor(options: InputPKCOptions);
+    _initMemCaches(): void;
+    private _initKuboRpcClientsIfNeeded;
+    private _initKuboPubsubClientsIfNeeded;
+    private _initLibp2pJsClientsIfNeeded;
+    private _initRpcClientsIfNeeded;
+    private _initIpfsGatewaysIfNeeded;
+    private _setupHttpRoutersWithKuboNodeInBackground;
+    _init(): Promise<void>;
+    getCommunity(getCommunityArgs: CommunityLookupRpcParam): Promise<RemoteCommunity>;
+    getComment(cid: CidRpcParam): Promise<Comment>;
+    private _initMissingFieldsOfPublicationBeforeSigning;
+    private _createCommentInstanceFromAnotherCommentInstance;
+    createComment(options: CommentIpfsType | CommentPubsubMessagePublication | {
+        cid: CommentUpdateType["cid"];
+        communityAddress?: string;
+        subplebbitAddress?: string;
+        communityPublicKey?: string;
+        communityName?: string;
+    } | MinimumCommentFieldsToFetchPages | CreateCommentOptions | CommentJson | Comment | CommentWithinRepliesPostsPageJson | CommentIpfsWithCidDefined): Promise<Comment>;
+    _canCreateNewLocalCommunity(): boolean;
+    protected _setCommunityIpfsOnInstanceIfPossible(community: RpcRemoteCommunity | RemoteCommunity, options: CreateRemoteCommunityOptions | CommunityIpfsType | RemoteCommunityJson | RpcRemoteCommunityJson): Promise<void>;
+    protected _waitForCommunitiesToBeDefined(): Promise<void>;
+    _awaitCommunitiesToIncludeCommunity(communityAddress: string): Promise<void>;
+    private _createRemoteCommunityInstance;
+    private _createLocalCommunity;
+    private _createCommunityInstanceFromJsonifiedCommunity;
+    createCommunity(options?: z.infer<typeof CreateCommunityFunctionArgumentsSchema> | CommunityJson): Promise<RemoteCommunity | RpcRemoteCommunity | RpcLocalCommunity | LocalCommunity>;
+    _createVoteInstanceFromJsonfiedVote(jsonfied: VoteJson): Promise<Vote>;
+    createVote(options: CreateVoteOptions | VotePubsubMessagePublication | VoteJson): Promise<Vote>;
+    _createCommentEditInstanceFromJsonfiedCommentEdit(jsonfied: CommentEditTypeJson): Promise<CommentEdit>;
+    createCommentEdit(options: CreateCommentEditOptions | CommentEditPubsubMessagePublication | CommentEditTypeJson): Promise<CommentEdit>;
+    _createCommentModerationInstanceFromJsonfiedCommentModeration(jsonfied: CommentModerationTypeJson): Promise<CommentModeration>;
+    createCommentModeration(options: CreateCommentModerationOptions | CommentModerationPubsubMessagePublication | CommentModerationTypeJson): Promise<CommentModeration>;
+    _createCommunityEditInstanceFromJsonfiedCommunityEdit(jsonfied: CommunityEditJson): Promise<CommunityEdit>;
+    createCommunityEdit(options: CreateCommunityEditPublicationOptions | CommunityEditPubsubMessagePublication | CommunityEditJson): Promise<CommunityEdit>;
+    createSigner(createSignerOptions?: CreateSignerOptions): Promise<import("../signer/index.js").SignerWithPublicKeyAddress>;
+    fetchCid(fetchCidArgs: CidRpcParam): Promise<string>;
+    pubsubSubscribe(pubsubTopic: string): Promise<void>;
+    pubsubUnsubscribe(pubsubTopic: string): Promise<void>;
+    resolveAuthorName(resolveAuthorAddressArgs: AuthorNameRpcParam): Promise<string | null>;
+    validateComment(comment: Comment | PageTypeJson["comments"][number], opts?: {
+        validateReplies?: boolean;
+    }): Promise<void>;
+    _createStorageLRU(opts: Omit<LRUStorageConstructor, "pkc">): Promise<LRUStorageInterface>;
+    destroy(): Promise<void>;
+}