@dxos/react-client 2.29.2-dev.f64f2a6f → 2.30.0

package/package.json

@@ -1,39 +1,30 @@
 {
   "name": "@dxos/react-client",
-  "version": "2.29.2-dev.f64f2a6f",
+  "version": "2.30.0",
   "description": "React client API",
   "license": "MIT",
   "author": "DXOS.org",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
-  "scripts": {
-    "book": "toolchain book",
-    "build": "toolchain build",
-    "build:book": "toolchain build:book",
-    "build:test": "toolchain build:test",
-    "lint": "toolchain lint",
-    "test": "toolchain test"
-  },
   "dependencies": {
-    "@dxos/async": "workspace:*",
-    "@dxos/bot-factory-client": "workspace:*",
-    "@dxos/client": "workspace:*",
-    "@dxos/config": "workspace:*",
-    "@dxos/credentials": "workspace:*",
-    "@dxos/crypto": "workspace:*",
-    "@dxos/debug": "workspace:*",
-    "@dxos/echo-db": "workspace:*",
-    "@dxos/network-manager": "workspace:*",
-    "@dxos/util": "workspace:*",
+    "@dxos/async": "2.30.0",
+    "@dxos/bot-factory-client": "2.30.0",
+    "@dxos/client": "2.30.0",
+    "@dxos/config": "2.30.0",
+    "@dxos/credentials": "2.30.0",
+    "@dxos/crypto": "2.30.0",
+    "@dxos/debug": "2.30.0",
+    "@dxos/echo-db": "2.30.0",
+    "@dxos/network-manager": "2.30.0",
+    "@dxos/util": "2.30.0",
     "assert": "^2.0.0",
     "debug": "^4.3.3",
-    "ipfs-http-client": "~56.0.1",
     "use-subscription": "^1.4.1"
   },
   "devDependencies": {
     "@dxos/esbuild-plugins": "~2.28.7",
     "@dxos/eslint-plugin": "~1.0.27",
-    "@dxos/protocols-toolchain": "workspace:*",
+    "@dxos/protocols-toolchain": "2.30.0",
     "@mui/material": "^5.4.2",
     "@testing-library/react": "^11.0.4",
     "@testing-library/react-hooks": "5.1.2",
@@ -48,7 +39,6 @@
     "expect": "~27.0.2",
     "fork-ts-checker-webpack-plugin": "~6.2.5",
     "level-js": "^5.0.2",
-    "node-fetch": "^2.6.0",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-test-renderer": "^17.0.2",
@@ -64,5 +54,14 @@
     "jsdom": true,
     "forceCloseTests": true,
     "testingFramework": "mocha"
-  }
-}
+  },
+  "scripts": {
+    "book": "toolchain book",
+    "build": "toolchain build",
+    "build:book": "toolchain build:book",
+    "build:test": "toolchain build:test",
+    "lint": "toolchain lint",
+    "test": "toolchain test"
+  },
+  "readme": "# @dxos/react-client\n\nA react implementation of the DXOS Client APIs.\n\n## Install\n\n```bash\ngit clone git@github.com:dxos/protocols.git\ncd protocols\nrush update\nrush build\n\ncd packages/sdk/demos\nrushx book\n```\n\n## Usage\n\nThe snippet below illustrates a self-contained DXOS application that uses providers to create the client and instantiate a user profile.\n\n```javascript\nimport { useClient, ClientProvider, ProfileInitializer } from '@dxos/react-client';\nimport React from 'react';\nimport ReactDOM from 'react-dom';\n\nconst App = () => {\n  const client = useClient();\n\n  return (\n    <pre>{JSON.stringify(client.info())}</pre>\n  );\n};\n\nconst Root = () => (\n  <ClientProvider>\n    <ProfileInitializer>\n      <App />\n    </ProfileInitializer>\n  </ClientProvider>\n);\n\nReactDOM.render(<Root/>, document.getElementById('root'));\n```\n\n## Storybooks\n\nThe [HALO Invitation Story](./stories/halo-invitations.stories.tsx) demonstrates multiple clients (devices) joining the same HALO.\n\nhttps://user-images.githubusercontent.com/3523355/137532718-a21f1f27-9854-4c0b-831a-e9ff92feac49.mov\n\nThe [Party Invitation Story](./stories/party-invitations.stories.tsx) demonstrates multiple clients creating and sharing parties.\n\nhttps://user-images.githubusercontent.com/3523355/137532717-e77395dc-96f9-4e4b-8f67-e6bd026a3abe.mov\n\n\n## Contributing\n\nPRs accepted.\n\n## License\n\nAGPL-3.0 © DXOS\n"
+}

package/src/hooks/index.ts

@@ -7,6 +7,5 @@ export * from './client';
 export * from './echo-queries';
 export * from './echo-selections';
 export * from './invitations';
-export * from './ipfs';
 export * from './util';
 export * from './wns';

package/src/hooks/invitations/useHaloInvitations.ts

@@ -2,10 +2,10 @@
 // Copyright 2022 DXOS.org
 //
 
-import { Client } from '@dxos/client';
+import { Client, HaloProxy } from '@dxos/client';
 
 import { useInvitations } from './useInvitations';
 
 export const useHaloInvitations = (client: Client) => {
-  return useInvitations(client.halo.invitationProxy);
+  return useInvitations((client.halo as HaloProxy).invitationProxy);
 };

package/src/hooks/invitations/useInvitations.ts

@@ -11,7 +11,6 @@ export const useInvitations = (invitationProxy: InvitationProxy | undefined) =>
 
   useEffect(() => {
     setInvitations(invitationProxy?.activeInvitations ?? []);
-
     return invitationProxy?.invitationsUpdate.on(() => {
       setInvitations([...invitationProxy.activeInvitations]);
     });

package/src/hooks/invitations/usePartyInvitations.ts

@@ -2,6 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
+import { PartyProxy } from '@dxos/client';
 import { PublicKey } from '@dxos/crypto';
 
 import { useParty } from '../echo-queries';
@@ -9,5 +10,5 @@ import { useInvitations } from './useInvitations';
 
 export const usePartyInvitations = (partyKey?: PublicKey) => {
   const party = useParty(partyKey);
-  return useInvitations(party?.invitationProxy);
+  return useInvitations((party as PartyProxy)?.invitationProxy);
 };

package/dist/src/hooks/ipfs/index.d.ts

@@ -1,3 +0,0 @@
-export * from './useIpfsClient';
-export * from './useIpfsFiles';
-//# sourceMappingURL=index.d.ts.map

package/dist/src/hooks/ipfs/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/hooks/ipfs/index.ts"],"names":[],"mappings":"AAIA,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}

package/dist/src/hooks/ipfs/index.js

@@ -1,18 +0,0 @@
-"use strict";
-//
-// Copyright 2022 DXOS.org
-//
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./useIpfsClient"), exports);
-__exportStar(require("./useIpfsFiles"), exports);
-//# sourceMappingURL=index.js.map

package/dist/src/hooks/ipfs/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/hooks/ipfs/index.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;;;;;;;;;;;AAEF,kDAAgC;AAChC,iDAA+B"}

package/dist/src/hooks/ipfs/useIpfsClient.d.ts

@@ -1,17 +0,0 @@
-import { CID } from 'ipfs-http-client';
-/**
- * Return URL to IPFS resource on local gateway.
- * @param gateway
- * @param cid
- * @param filename
- */
-export declare const getIpfsUrl: (gateway: string, cid: CID, filename?: string | undefined) => string;
-/**
- * https://www.npmjs.com/package/ipfs-http-client#example
- * NOTE: We need to run our own servers to enable CORS.
- * Ports
- * - 8001 Gateway
- * - 5001 API
- */
-export declare const useIpfsClient: (url?: string | undefined) => import("ipfs-http-client/types/src/types").IPFSHTTPClient | undefined;
-//# sourceMappingURL=useIpfsClient.d.ts.map

package/dist/src/hooks/ipfs/useIpfsClient.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useIpfsClient.d.ts","sourceRoot":"","sources":["../../../../src/hooks/ipfs/useIpfsClient.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,GAAG,EAAU,MAAM,kBAAkB,CAAC;AAI/C;;;;;GAKG;AACH,eAAO,MAAM,UAAU,YAAa,MAAM,OAAO,GAAG,0CAGnD,CAAC;AAEF;;;;;;GAMG;AAEH,eAAO,MAAM,aAAa,qGAQzB,CAAC"}

package/dist/src/hooks/ipfs/useIpfsClient.js

@@ -1,41 +0,0 @@
-"use strict";
-//
-// Copyright 2022 DXOS.org
-//
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useIpfsClient = exports.getIpfsUrl = void 0;
-const ipfs_http_client_1 = require("ipfs-http-client");
-const path_1 = __importDefault(require("path"));
-const react_1 = require("react");
-/**
- * Return URL to IPFS resource on local gateway.
- * @param gateway
- * @param cid
- * @param filename
- */
-const getIpfsUrl = (gateway, cid, filename) => {
-    const args = filename ? [`filename=${encodeURI(filename)}`] : [];
-    return path_1.default.join(gateway, String(cid), '?', args.join('&'));
-};
-exports.getIpfsUrl = getIpfsUrl;
-/**
- * https://www.npmjs.com/package/ipfs-http-client#example
- * NOTE: We need to run our own servers to enable CORS.
- * Ports
- * - 8001 Gateway
- * - 5001 API
- */
-// TODO(kaplanski): Factor out IPFS related functionality to its own package.
-const useIpfsClient = (url) => {
-    return (0, react_1.useMemo)(() => {
-        if (!url) {
-            return undefined;
-        }
-        return (0, ipfs_http_client_1.create)({ url });
-    }, [url]);
-};
-exports.useIpfsClient = useIpfsClient;
-//# sourceMappingURL=useIpfsClient.js.map

package/dist/src/hooks/ipfs/useIpfsClient.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useIpfsClient.js","sourceRoot":"","sources":["../../../../src/hooks/ipfs/useIpfsClient.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;;;;;AAEF,uDAA+C;AAC/C,gDAAwB;AACxB,iCAAgC;AAEhC;;;;;GAKG;AACI,MAAM,UAAU,GAAG,CAAC,OAAe,EAAE,GAAQ,EAAE,QAAiB,EAAE,EAAE;IACzE,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,YAAY,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,OAAO,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC9D,CAAC,CAAC;AAHW,QAAA,UAAU,cAGrB;AAEF;;;;;;GAMG;AACH,6EAA6E;AACtE,MAAM,aAAa,GAAG,CAAC,GAAY,EAAE,EAAE;IAC5C,OAAO,IAAA,eAAO,EAAC,GAAG,EAAE;QAClB,IAAI,CAAC,GAAG,EAAE;YACR,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,IAAA,yBAAM,EAAC,EAAE,GAAG,EAAE,CAAC,CAAC;IACzB,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AACZ,CAAC,CAAC;AARW,QAAA,aAAa,iBAQxB"}

package/dist/src/hooks/ipfs/useIpfsFiles.d.ts

@@ -1,19 +0,0 @@
-import { CID, IPFSHTTPClient } from 'ipfs-http-client';
-import { Party } from '@dxos/client';
-export declare type IPFSFile = {
-    filename?: string;
-    cid: CID;
-    size?: number;
-};
-/**
- * Returns a list of mapped IPFS files.
- * @param party
- * @param type
- */
-export declare const useIpfsFiles: (party: Party | undefined, type: string) => IPFSFile[];
-export declare const uploadFilesToIpfs: (ipfsClient: IPFSHTTPClient, files: File[], onError?: ((error: Error) => void) | undefined) => Promise<({
-    cid: string;
-    size: number;
-    filename: string;
-} | undefined)[]>;
-//# sourceMappingURL=useIpfsFiles.d.ts.map

package/dist/src/hooks/ipfs/useIpfsFiles.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useIpfsFiles.d.ts","sourceRoot":"","sources":["../../../../src/hooks/ipfs/useIpfsFiles.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAGvD,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAIrC,oBAAY,QAAQ,GAAG;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,GAAG,CAAA;IACR,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,YAAY,UAAW,KAAK,GAAG,SAAS,QAAQ,MAAM,eAYlE,CAAC;AAGF,eAAO,MAAM,iBAAiB,eAChB,cAAc,SACnB,IAAI,EAAE,qBACK,KAAK,KAAK,IAAI;;;;iBAkBjC,CAAC"}

package/dist/src/hooks/ipfs/useIpfsFiles.js

@@ -1,48 +0,0 @@
-"use strict";
-//
-// Copyright 2022 DXOS.org
-//
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadFilesToIpfs = exports.useIpfsFiles = void 0;
-const react_1 = require("react");
-const echo_selections_1 = require("../echo-selections");
-/**
- * Returns a list of mapped IPFS files.
- * @param party
- * @param type
- */
-const useIpfsFiles = (party, type) => {
-    var _a;
-    // TODO(burdon): Schema definitions for types?
-    // TODO(burdon): Use reducer to do mapping?
-    const items = (0, echo_selections_1.useSelection)(party === null || party === void 0 ? void 0 : party.select().filter({ type }));
-    const files = (_a = (0, react_1.useMemo)(() => items === null || items === void 0 ? void 0 : items.map(item => ({
-        filename: item.model.getProperty('filename'),
-        cid: item.model.getProperty('cid'),
-        size: item.model.getProperty('size')
-    })), [items])) !== null && _a !== void 0 ? _a : [];
-    return files;
-};
-exports.useIpfsFiles = useIpfsFiles;
-// TODO(wittjosiah): This is not returning IPFSFiles.
-const uploadFilesToIpfs = async (ipfsClient, files, onError) => {
-    return await Promise.all(files.map(async (file) => {
-        // https://docs.ipfs.io/reference/js/api
-        // https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-http-client
-        try {
-            const { cid, path, size } = await ipfsClient.add(file);
-            await ipfsClient.pin.add(cid);
-            // TODO(kaplanski): path is CID v0. cid is CID v1. Current default is v0, but will be updated to v1 in the future. We'll need to update to support v1.
-            return {
-                cid: path,
-                size,
-                filename: file.name
-            };
-        }
-        catch (err) {
-            onError === null || onError === void 0 ? void 0 : onError(err instanceof Error ? err : new Error(err)); // TODO(burdon): Generalize.
-        }
-    }));
-};
-exports.uploadFilesToIpfs = uploadFilesToIpfs;
-//# sourceMappingURL=useIpfsFiles.js.map

package/dist/src/hooks/ipfs/useIpfsFiles.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useIpfsFiles.js","sourceRoot":"","sources":["../../../../src/hooks/ipfs/useIpfsFiles.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;;AAGF,iCAAgC;AAIhC,wDAAkD;AAQlD;;;;GAIG;AACI,MAAM,YAAY,GAAG,CAAC,KAAwB,EAAE,IAAY,EAAE,EAAE;;IACrE,8CAA8C;IAC9C,2CAA2C;IAC3C,MAAM,KAAK,GAAG,IAAA,8BAAY,EAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,GAAG,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAE7D,MAAM,KAAK,GAAe,MAAA,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1D,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC;QAC5C,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC;QAClC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC;KACrC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,mCAAI,EAAE,CAAC;IAEpB,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAZW,QAAA,YAAY,gBAYvB;AAEF,qDAAqD;AAC9C,MAAM,iBAAiB,GAAG,KAAK,EACpC,UAA0B,EAC1B,KAAa,EACb,OAAgC,EAChC,EAAE;IACF,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAChD,wCAAwC;QACxC,wEAAwE;QACxE,IAAI;YACF,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACvD,MAAM,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC9B,sJAAsJ;YACtJ,OAAO;gBACL,GAAG,EAAE,IAAI;gBACT,IAAI;gBACJ,QAAQ,EAAE,IAAI,CAAC,IAAI;aACpB,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,GAAa,CAAC,CAAC,CAAC,CAAC,4BAA4B;SAC/F;IACH,CAAC,CAAC,CAAC,CAAC;AACN,CAAC,CAAC;AArBW,QAAA,iBAAiB,qBAqB5B"}

package/src/hooks/ipfs/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-export * from './useIpfsClient';
-export * from './useIpfsFiles';

package/src/hooks/ipfs/useIpfsClient.ts

@@ -1,36 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import { CID, create } from 'ipfs-http-client';
-import path from 'path';
-import { useMemo } from 'react';
-
-/**
- * Return URL to IPFS resource on local gateway.
- * @param gateway
- * @param cid
- * @param filename
- */
-export const getIpfsUrl = (gateway: string, cid: CID, filename?: string) => {
-  const args = filename ? [`filename=${encodeURI(filename)}`] : [];
-  return path.join(gateway, String(cid), '?', args.join('&'));
-};
-
-/**
- * https://www.npmjs.com/package/ipfs-http-client#example
- * NOTE: We need to run our own servers to enable CORS.
- * Ports
- * - 8001 Gateway
- * - 5001 API
- */
-// TODO(kaplanski): Factor out IPFS related functionality to its own package.
-export const useIpfsClient = (url?: string) => {
-  return useMemo(() => {
-    if (!url) {
-      return undefined;
-    }
-
-    return create({ url });
-  }, [url]);
-};

package/src/hooks/ipfs/useIpfsFiles.ts

@@ -1,59 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import { CID, IPFSHTTPClient } from 'ipfs-http-client';
-import { useMemo } from 'react';
-
-import { Party } from '@dxos/client';
-
-import { useSelection } from '../echo-selections';
-
-export type IPFSFile = {
-  filename?: string
-  cid: CID
-  size?: number
-}
-
-/**
- * Returns a list of mapped IPFS files.
- * @param party
- * @param type
- */
-export const useIpfsFiles = (party: Party | undefined, type: string) => {
-  // TODO(burdon): Schema definitions for types?
-  // TODO(burdon): Use reducer to do mapping?
-  const items = useSelection(party?.select().filter({ type }));
-
-  const files: IPFSFile[] = useMemo(() => items?.map(item => ({
-    filename: item.model.getProperty('filename'),
-    cid: item.model.getProperty('cid'),
-    size: item.model.getProperty('size')
-  })), [items]) ?? [];
-
-  return files;
-};
-
-// TODO(wittjosiah): This is not returning IPFSFiles.
-export const uploadFilesToIpfs = async (
-  ipfsClient: IPFSHTTPClient,
-  files: File[],
-  onError?: (error: Error) => void
-) => {
-  return await Promise.all(files.map(async (file) => {
-    // https://docs.ipfs.io/reference/js/api
-    // https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-http-client
-    try {
-      const { cid, path, size } = await ipfsClient.add(file);
-      await ipfsClient.pin.add(cid);
-      // TODO(kaplanski): path is CID v0. cid is CID v1. Current default is v0, but will be updated to v1 in the future. We'll need to update to support v1.
-      return {
-        cid: path,
-        size,
-        filename: file.name
-      };
-    } catch (err) {
-      onError?.(err instanceof Error ? err : new Error(err as string)); // TODO(burdon): Generalize.
-    }
-  }));
-};