@dxos/react-client 0.6.13-main.ed424a1 → 0.6.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/dist/lib/browser/{chunk-RJRDB4LF.mjs → chunk-CL7JDETM.mjs} +60 -62
  2. package/dist/lib/browser/chunk-CL7JDETM.mjs.map +7 -0
  3. package/dist/lib/browser/devtools/index.mjs +1 -1
  4. package/dist/lib/browser/echo/index.mjs +4 -6
  5. package/dist/lib/browser/echo/index.mjs.map +3 -3
  6. package/dist/lib/browser/halo/index.mjs +1 -1
  7. package/dist/lib/browser/index.mjs +3 -1
  8. package/dist/lib/browser/index.mjs.map +1 -1
  9. package/dist/lib/browser/mesh/index.mjs +1 -1
  10. package/dist/lib/browser/meta.json +1 -1
  11. package/dist/lib/browser/testing/index.mjs +32 -43
  12. package/dist/lib/browser/testing/index.mjs.map +3 -3
  13. package/dist/lib/node/{chunk-YNTACPMY.cjs → chunk-C4EWAKPZ.cjs} +60 -63
  14. package/dist/lib/node/chunk-C4EWAKPZ.cjs.map +7 -0
  15. package/dist/lib/node/devtools/index.cjs +2 -2
  16. package/dist/lib/node/echo/index.cjs +5 -7
  17. package/dist/lib/node/echo/index.cjs.map +3 -3
  18. package/dist/lib/node/halo/index.cjs +5 -5
  19. package/dist/lib/node/index.cjs +14 -12
  20. package/dist/lib/node/index.cjs.map +1 -1
  21. package/dist/lib/node/mesh/index.cjs +2 -2
  22. package/dist/lib/node/meta.json +1 -1
  23. package/dist/lib/node/testing/index.cjs +33 -44
  24. package/dist/lib/node/testing/index.cjs.map +3 -3
  25. package/dist/types/src/client/ClientProvider.d.ts +18 -59
  26. package/dist/types/src/client/ClientProvider.d.ts.map +1 -1
  27. package/dist/types/src/client/context.d.ts +4 -1
  28. package/dist/types/src/client/context.d.ts.map +1 -1
  29. package/dist/types/src/client/index.d.ts +1 -0
  30. package/dist/types/src/client/index.d.ts.map +1 -1
  31. package/dist/types/src/client/useClientServices.d.ts +3 -0
  32. package/dist/types/src/client/useClientServices.d.ts.map +1 -0
  33. package/dist/types/src/echo/useQuery.d.ts.map +1 -1
  34. package/dist/types/src/playwright/playwright.config.d.ts +2 -2
  35. package/dist/types/src/playwright/playwright.config.d.ts.map +1 -1
  36. package/dist/types/src/testing/ClientRepeater.d.ts +12 -9
  37. package/dist/types/src/testing/ClientRepeater.d.ts.map +1 -1
  38. package/dist/types/src/testing/util.d.ts +3 -5
  39. package/dist/types/src/testing/util.d.ts.map +1 -1
  40. package/dist/types/src/testing/withClientProvider.d.ts +1 -4
  41. package/dist/types/src/testing/withClientProvider.d.ts.map +1 -1
  42. package/dist/types/src/testing/withClientProvider.stories.d.ts +3 -4
  43. package/dist/types/src/testing/withClientProvider.stories.d.ts.map +1 -1
  44. package/package.json +38 -47
  45. package/project.json +22 -3
  46. package/src/client/ClientProvider.test.tsx +4 -7
  47. package/src/client/ClientProvider.tsx +100 -126
  48. package/src/client/context.ts +5 -4
  49. package/src/client/index.ts +3 -0
  50. package/src/client/useClientServices.ts +15 -0
  51. package/src/client/useConfig.test.tsx +12 -9
  52. package/src/echo/useQuery.ts +6 -3
  53. package/src/echo/useSpaces.test.tsx +8 -6
  54. package/src/halo/useDevices.test.tsx +5 -3
  55. package/src/playwright/playwright.config.ts +2 -13
  56. package/src/playwright/smoke.spec.ts +10 -5
  57. package/src/testing/ClientRepeater.tsx +20 -19
  58. package/src/testing/util.tsx +6 -11
  59. package/src/testing/withClientProvider.stories.tsx +10 -19
  60. package/src/testing/withClientProvider.tsx +18 -22
  61. package/tsconfig.json +58 -2
  62. package/dist/lib/browser/chunk-RJRDB4LF.mjs.map +0 -7
  63. package/dist/lib/node/chunk-YNTACPMY.cjs.map +0 -7
  64. package/dist/lib/node-esm/chunk-UYJUBYMU.mjs +0 -165
  65. package/dist/lib/node-esm/chunk-UYJUBYMU.mjs.map +0 -7
  66. package/dist/lib/node-esm/chunk-V65AVUQO.mjs +0 -295
  67. package/dist/lib/node-esm/chunk-V65AVUQO.mjs.map +0 -7
  68. package/dist/lib/node-esm/devtools/index.mjs +0 -44
  69. package/dist/lib/node-esm/devtools/index.mjs.map +0 -7
  70. package/dist/lib/node-esm/echo/index.mjs +0 -134
  71. package/dist/lib/node-esm/echo/index.mjs.map +0 -7
  72. package/dist/lib/node-esm/halo/index.mjs +0 -100
  73. package/dist/lib/node-esm/halo/index.mjs.map +0 -7
  74. package/dist/lib/node-esm/index.mjs +0 -33
  75. package/dist/lib/node-esm/index.mjs.map +0 -7
  76. package/dist/lib/node-esm/invitations/index.mjs +0 -18
  77. package/dist/lib/node-esm/invitations/index.mjs.map +0 -7
  78. package/dist/lib/node-esm/mesh/index.mjs +0 -18
  79. package/dist/lib/node-esm/mesh/index.mjs.map +0 -7
  80. package/dist/lib/node-esm/meta.json +0 -1
  81. package/dist/lib/node-esm/testing/index.mjs +0 -177
  82. package/dist/lib/node-esm/testing/index.mjs.map +0 -7
  83. package/dist/lib/node-esm/worker.mjs +0 -5
  84. package/dist/lib/node-esm/worker.mjs.map +0 -7
  85. package/vitest.config.ts +0 -22
@@ -1,3 +1,3 @@
1
- declare const _default: import("@playwright/test").PlaywrightTestConfig<{}, {}>;
2
- export default _default;
1
+ import { defaultPlaywrightConfig } from '@dxos/test/playwright';
2
+ export default defaultPlaywrightConfig;
3
3
  //# sourceMappingURL=playwright.config.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"playwright.config.d.ts","sourceRoot":"","sources":["../../../../src/playwright/playwright.config.ts"],"names":[],"mappings":";AASA,wBAQG"}
1
+ {"version":3,"file":"playwright.config.d.ts","sourceRoot":"","sources":["../../../../src/playwright/playwright.config.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,eAAe,uBAAuB,CAAC"}
@@ -1,28 +1,31 @@
1
- import { type Schema as S } from '@effect/schema';
2
1
  import React, { type FC } from 'react';
3
2
  import { Client, type PublicKey } from '@dxos/client';
4
- import { type WithClientProviderProps } from './withClientProvider';
3
+ import { type Space } from '@dxos/client/echo';
4
+ import { type S } from '@dxos/echo-schema';
5
+ import { type MaybePromise } from '@dxos/util';
5
6
  export type ClientRepeatedComponentProps = {
6
7
  id: number;
7
8
  count: number;
8
9
  spaceKey?: PublicKey;
9
10
  };
10
- export type ClientRepeaterControlsProps = {
11
- clients: Client[];
12
- };
13
11
  export type ClientRepeaterProps<P extends ClientRepeatedComponentProps> = {
14
12
  className?: string;
15
13
  component: FC<ClientRepeatedComponentProps>;
16
- controls?: FC<ClientRepeaterControlsProps>;
17
- count?: number;
14
+ controls?: FC<{
15
+ clients: Client[];
16
+ }>;
18
17
  clients?: Client[];
18
+ count?: number;
19
+ registerSignalFactory?: boolean;
19
20
  types?: S.Schema<any>[];
21
+ createIdentity?: boolean;
22
+ createSpace?: boolean;
23
+ onCreateSpace?: (space: Space) => MaybePromise<void>;
20
24
  args?: Omit<P, 'id' | 'count'>;
21
- } & Pick<WithClientProviderProps, 'createIdentity' | 'createSpace' | 'onSpaceCreated'>;
25
+ };
22
26
  /**
23
27
  * Utility component for Storybook stories which sets up clients for n peers.
24
28
  * The `Component` property is rendered n times, once for each peer.
25
- * @deprecated use `withClientProvider`.
26
29
  */
27
30
  export declare const ClientRepeater: <P extends ClientRepeatedComponentProps>(props: ClientRepeaterProps<P>) => React.JSX.Element | null;
28
31
  //# sourceMappingURL=ClientRepeater.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ClientRepeater.d.ts","sourceRoot":"","sources":["../../../../src/testing/ClientRepeater.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,MAAM,IAAI,CAAC,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,EAAY,KAAK,EAAE,EAAqB,MAAM,OAAO,CAAC;AAEpE,OAAO,EAAE,MAAM,EAAE,KAAK,SAAS,EAAE,MAAM,cAAc,CAAC;AAKtD,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAGpE,MAAM,MAAM,4BAA4B,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAE/F,MAAM,MAAM,2BAA2B,GAAG;IAAE,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAGhE,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,4BAA4B,IAAI;IACxE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,EAAE,CAAC,4BAA4B,CAAC,CAAC;IAC5C,QAAQ,CAAC,EAAE,EAAE,CAAC,2BAA2B,CAAC,CAAC;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC;CAChC,GAAG,IAAI,CAAC,uBAAuB,EAAE,gBAAgB,GAAG,aAAa,GAAG,gBAAgB,CAAC,CAAC;AAEvF;;;;GAIG;AAMH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,4BAA4B,SAAS,mBAAmB,CAAC,CAAC,CAAC,6BA2DnG,CAAC"}
1
+ {"version":3,"file":"ClientRepeater.d.ts","sourceRoot":"","sources":["../../../../src/testing/ClientRepeater.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,EAAY,KAAK,EAAE,EAAqB,MAAM,OAAO,CAAC;AAEpE,OAAO,EAAE,MAAM,EAAE,KAAK,SAAS,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,mBAAmB,CAAC;AAG3C,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAI/C,MAAM,MAAM,4BAA4B,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAE/F,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,4BAA4B,IAAI;IACxE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,EAAE,CAAC,4BAA4B,CAAC,CAAC;IAC5C,QAAQ,CAAC,EAAE,EAAE,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;IACrC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,KAAK,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;IACrD,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC;CAChC,CAAC;AAEF;;;GAGG;AAMH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,4BAA4B,SAAS,mBAAmB,CAAC,CAAC,CAAC,6BA2DnG,CAAC"}
@@ -1,14 +1,12 @@
1
1
  import React from 'react';
2
- import { Client, type Config } from '@dxos/client';
2
+ import { Client } from '@dxos/client';
3
3
  import { type Space } from '@dxos/client/echo';
4
- export declare const createClient: ({ config, createIdentity, createSpace, }?: {
5
- config?: Config;
4
+ export declare const createClient: ({ createIdentity, createSpace, }?: {
6
5
  createIdentity?: boolean;
7
6
  createSpace?: boolean;
8
7
  }) => Promise<{
9
8
  client: Client;
10
9
  space: Space | undefined;
11
10
  }>;
12
- export declare const createClientContextProvider: (client: Client) => Promise<({ children }: any) => React.JSX.Element>;
13
- export declare const createClientProvider: (client: Client) => Promise<({ children }: any) => React.JSX.Element>;
11
+ export declare const createContextProvider: (client: Client) => Promise<({ children }: any) => React.JSX.Element>;
14
12
  //# sourceMappingURL=util.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../../src/testing/util.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,MAAM,EAAE,KAAK,MAAM,EAAY,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAK/C,eAAO,MAAM,YAAY,8CAItB;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE;;;EActE,CAAC;AAEF,eAAO,MAAM,2BAA2B,WAAkB,MAAM,4BACxC,GAAG,uBAC1B,CAAC;AAEF,eAAO,MAAM,oBAAoB,WAAkB,MAAM,4BACjC,GAAG,uBAC1B,CAAC"}
1
+ {"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../../src/testing/util.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,MAAM,EAAY,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAI/C,eAAO,MAAM,YAAY,sCAGtB;IAAE,cAAc,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE;;;EAcrD,CAAC;AAGF,eAAO,MAAM,qBAAqB,WAAkB,MAAM,4BAClC,GAAG,uBAC1B,CAAC"}
@@ -6,10 +6,7 @@ import { type ClientProviderProps } from '../client';
6
6
  type InitializeProps = {
7
7
  createIdentity?: boolean;
8
8
  createSpace?: boolean;
9
- onSpaceCreated?: (props: {
10
- client: Client;
11
- space: Space;
12
- }) => MaybePromise<void>;
9
+ onSpaceCreated?: (client: Client, space: Space) => MaybePromise<void>;
13
10
  };
14
11
  export type WithClientProviderProps = InitializeProps & ClientProviderProps;
15
12
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"withClientProvider.d.ts","sourceRoot":"","sources":["../../../../src/testing/withClientProvider.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAKlD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAkB,KAAK,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAErE,KAAK,eAAe,GAAG;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;CAClF,CAAC;AA8BF,MAAM,MAAM,uBAAuB,GAAG,eAAe,GAAG,mBAAmB,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,kBAAkB,8EAM5B,uBAAuB,KAAQ,SAcjC,CAAC;AAKF,MAAM,MAAM,4BAA4B,GAAG,eAAe,GAAG,mBAAmB,GAAG;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3G;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,yFAOjC,4BAA4B,KAAG,SAuCjC,CAAC"}
1
+ {"version":3,"file":"withClientProvider.d.ts","sourceRoot":"","sources":["../../../../src/testing/withClientProvider.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAKlD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAkB,KAAK,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAErE,KAAK,eAAe,GAAG;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;CACvE,CAAC;AA4BF,MAAM,MAAM,uBAAuB,GAAG,eAAe,GAAG,mBAAmB,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,kBAAkB,8EAM5B,uBAAuB,KAAQ,SAYjC,CAAC;AAKF,MAAM,MAAM,4BAA4B,GAAG,eAAe,GAAG,mBAAmB,GAAG;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3G;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,yFAOjC,4BAA4B,KAAG,SAuCjC,CAAC"}
@@ -2,12 +2,11 @@ import '@dxos-theme';
2
2
  import React from 'react';
3
3
  declare const _default: {
4
4
  title: string;
5
- render: () => React.JSX.Element | null;
6
- };
7
- export default _default;
8
- export declare const Default: {
5
+ component: () => React.JSX.Element | null;
9
6
  decorators: import("@storybook/react/*").Decorator[];
10
7
  };
8
+ export default _default;
9
+ export declare const Default: {};
11
10
  export declare const Multiple: {
12
11
  decorators: import("@storybook/react/*").Decorator[];
13
12
  };
@@ -1 +1 @@
1
- {"version":3,"file":"withClientProvider.stories.d.ts","sourceRoot":"","sources":["../../../../src/testing/withClientProvider.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;AAErB,OAAO,KAAK,MAAM,OAAO,CAAC;;;;;AAgC1B,wBAGE;AAaF,eAAO,MAAM,OAAO;;CAEnB,CAAC;AAEF,eAAO,MAAM,QAAQ;;CAMpB,CAAC"}
1
+ {"version":3,"file":"withClientProvider.stories.d.ts","sourceRoot":"","sources":["../../../../src/testing/withClientProvider.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;AAErB,OAAO,KAAK,MAAM,OAAO,CAAC;;;;;;AA+B1B,wBAIE;AAEF,eAAO,MAAM,OAAO,IAAK,CAAC;AAE1B,eAAO,MAAM,QAAQ;;CAUpB,CAAC"}
package/package.json CHANGED
@@ -1,73 +1,65 @@
1
1
  {
2
2
  "name": "@dxos/react-client",
3
- "version": "0.6.13-main.ed424a1",
3
+ "version": "0.6.13",
4
4
  "description": "React client API",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
7
7
  "license": "MIT",
8
8
  "author": "DXOS.org",
9
9
  "exports": {
10
+ ".": {
11
+ "browser": "./dist/lib/browser/index.mjs",
12
+ "node": {
13
+ "default": "./dist/lib/node/index.cjs"
14
+ },
15
+ "types": "./dist/types/src/index.d.ts"
16
+ },
10
17
  "./devtools": {
11
18
  "browser": "./dist/lib/browser/devtools/index.mjs",
12
19
  "node": {
13
- "require": "./dist/lib/node/devtools/index.cjs",
14
- "default": "./dist/lib/node-esm/devtools/index.mjs"
20
+ "default": "./dist/lib/node/devtools/index.cjs"
15
21
  },
16
22
  "types": "./dist/types/src/devtools/index.d.ts"
17
23
  },
18
24
  "./echo": {
19
25
  "browser": "./dist/lib/browser/echo/index.mjs",
20
26
  "node": {
21
- "require": "./dist/lib/node/echo/index.cjs",
22
- "default": "./dist/lib/node-esm/echo/index.mjs"
27
+ "default": "./dist/lib/node/echo/index.cjs"
23
28
  },
24
29
  "types": "./dist/types/src/echo/index.d.ts"
25
30
  },
26
31
  "./halo": {
27
32
  "browser": "./dist/lib/browser/halo/index.mjs",
28
33
  "node": {
29
- "require": "./dist/lib/node/halo/index.cjs",
30
- "default": "./dist/lib/node-esm/halo/index.mjs"
34
+ "default": "./dist/lib/node/halo/index.cjs"
31
35
  },
32
36
  "types": "./dist/types/src/halo/index.d.ts"
33
37
  },
34
- ".": {
35
- "browser": "./dist/lib/browser/index.mjs",
36
- "node": {
37
- "require": "./dist/lib/node/index.cjs",
38
- "default": "./dist/lib/node-esm/index.mjs"
39
- },
40
- "types": "./dist/types/src/index.d.ts"
41
- },
42
38
  "./invitations": {
43
39
  "browser": "./dist/lib/browser/invitations/index.mjs",
44
40
  "node": {
45
- "require": "./dist/lib/node/invitations/index.cjs",
46
- "default": "./dist/lib/node-esm/invitations/index.mjs"
41
+ "default": "./dist/lib/node/invitations/index.cjs"
47
42
  },
48
43
  "types": "./dist/types/src/invitations/index.d.ts"
49
44
  },
50
45
  "./mesh": {
51
46
  "browser": "./dist/lib/browser/mesh/index.mjs",
52
47
  "node": {
53
- "require": "./dist/lib/node/mesh/index.cjs",
54
- "default": "./dist/lib/node-esm/mesh/index.mjs"
48
+ "default": "./dist/lib/node/mesh/index.cjs"
55
49
  },
56
50
  "types": "./dist/types/src/mesh/index.d.ts"
57
51
  },
58
52
  "./testing": {
59
53
  "browser": "./dist/lib/browser/testing/index.mjs",
60
54
  "node": {
61
- "require": "./dist/lib/node/testing/index.cjs",
62
- "default": "./dist/lib/node-esm/testing/index.mjs"
55
+ "default": "./dist/lib/node/testing/index.cjs"
63
56
  },
64
57
  "types": "./dist/types/src/testing/index.d.ts"
65
58
  },
66
59
  "./worker": {
67
60
  "browser": "./dist/lib/browser/worker.mjs",
68
61
  "node": {
69
- "require": "./dist/lib/node/worker.cjs",
70
- "default": "./dist/lib/node-esm/worker.mjs"
62
+ "default": "./dist/lib/node/worker.cjs"
71
63
  },
72
64
  "types": "./dist/types/src/worker.d.ts"
73
65
  }
@@ -100,19 +92,19 @@
100
92
  },
101
93
  "dependencies": {
102
94
  "react-error-boundary": "^4.0.13",
103
- "@dxos/async": "0.6.13-main.ed424a1",
104
- "@dxos/client": "0.6.13-main.ed424a1",
105
- "@dxos/codec-protobuf": "0.6.13-main.ed424a1",
106
- "@dxos/debug": "0.6.13-main.ed424a1",
107
- "@dxos/echo-schema": "0.6.13-main.ed424a1",
108
- "@dxos/config": "0.6.13-main.ed424a1",
109
- "@dxos/echo-signals": "0.6.13-main.ed424a1",
110
- "@dxos/log": "0.6.13-main.ed424a1",
111
- "@dxos/invariant": "0.6.13-main.ed424a1",
112
- "@dxos/node-std": "0.6.13-main.ed424a1",
113
- "@dxos/protocols": "0.6.13-main.ed424a1",
114
- "@dxos/util": "0.6.13-main.ed424a1",
115
- "@dxos/react-hooks": "0.6.13-main.ed424a1"
95
+ "@dxos/async": "0.6.13",
96
+ "@dxos/codec-protobuf": "0.6.13",
97
+ "@dxos/debug": "0.6.13",
98
+ "@dxos/config": "0.6.13",
99
+ "@dxos/client": "0.6.13",
100
+ "@dxos/echo-schema": "0.6.13",
101
+ "@dxos/echo-signals": "0.6.13",
102
+ "@dxos/invariant": "0.6.13",
103
+ "@dxos/protocols": "0.6.13",
104
+ "@dxos/node-std": "0.6.13",
105
+ "@dxos/log": "0.6.13",
106
+ "@dxos/react-hooks": "0.6.13",
107
+ "@dxos/util": "0.6.13"
116
108
  },
117
109
  "devDependencies": {
118
110
  "@testing-library/dom": "^8.17.1",
@@ -122,21 +114,20 @@
122
114
  "@types/react-dom": "~18.2.0",
123
115
  "react": "~18.2.0",
124
116
  "react-dom": "~18.2.0",
125
- "@dxos/random": "0.6.13-main.ed424a1",
126
- "@dxos/react-ui": "0.6.13-main.ed424a1",
127
- "@dxos/react-ui-syntax-highlighter": "0.6.13-main.ed424a1",
128
- "@dxos/react-ui-theme": "0.6.13-main.ed424a1",
129
- "@dxos/storybook-utils": "0.6.13-main.ed424a1",
130
- "@dxos/test-utils": "0.6.13-main.ed424a1"
117
+ "@dxos/react-ui-syntax-highlighter": "0.6.13",
118
+ "@dxos/react-ui": "0.6.13",
119
+ "@dxos/random": "0.6.13",
120
+ "@dxos/react-ui-theme": "0.6.13",
121
+ "@dxos/storybook-utils": "0.6.13"
131
122
  },
132
123
  "peerDependencies": {
133
- "react": "~18.2.0",
134
- "react-dom": "~18.2.0",
135
- "@dxos/react-ui": "0.6.13-main.ed424a1",
136
- "@dxos/react-ui-theme": "0.6.13-main.ed424a1"
124
+ "react": "^18.0.0",
125
+ "react-dom": "^18.0.0",
126
+ "@dxos/react-ui": "0.6.13",
127
+ "@dxos/react-ui-theme": "0.6.13"
137
128
  },
138
129
  "optionalDependencies": {
139
- "@dxos/random": "0.6.13-main.ed424a1"
130
+ "@dxos/random": "0.6.13"
140
131
  },
141
132
  "publishConfig": {
142
133
  "access": "public"
package/project.json CHANGED
@@ -26,13 +26,32 @@
26
26
  "dependsOn": [
27
27
  "^compile",
28
28
  "stories:mkdist"
29
- ]
29
+ ],
30
+ "options": {
31
+ "playwrightConfigPath": "{projectRoot}/src/playwright/playwright.config.ts",
32
+ "serve": "stories:storybook-e2e",
33
+ "testPatterns": [
34
+ "{projectRoot}/src/playwright/**/*.spec.{ts,js}"
35
+ ],
36
+ "timeout": 60000,
37
+ "watchPatterns": [
38
+ "{projectRoot}/src/**/*"
39
+ ]
40
+ }
30
41
  },
31
42
  "lint": {},
32
- "test": {}
43
+ "test": {
44
+ "options": {
45
+ "ciEnvironments": [
46
+ "nodejs"
47
+ ],
48
+ "domRequired": true,
49
+ "forceExit": true
50
+ }
51
+ }
33
52
  },
34
53
  "implicitDependencies": [
35
54
  "esbuild",
36
- "node-std"
55
+ "test"
37
56
  ]
38
57
  }
@@ -2,13 +2,14 @@
2
2
  // Copyright 2020 DXOS.org
3
3
  //
4
4
 
5
- import { renderHook, screen, render, act, cleanup } from '@testing-library/react';
5
+ import { renderHook, screen, render, act } from '@testing-library/react';
6
+ import expect from 'expect';
6
7
  import React, { Component, type PropsWithChildren } from 'react';
7
- import { afterEach, beforeEach, describe, expect, test } from 'vitest';
8
8
 
9
9
  import { waitForCondition } from '@dxos/async';
10
10
  import { Client, Config, SystemStatus, fromHost } from '@dxos/client';
11
11
  import { log } from '@dxos/log';
12
+ import { describe, test } from '@dxos/test';
12
13
 
13
14
  import { ClientProvider } from './ClientProvider';
14
15
  import { useClient } from './useClient';
@@ -96,10 +97,6 @@ describe('ClientProvider', () => {
96
97
  await client.halo.createIdentity({ displayName: 'test-user' });
97
98
  });
98
99
 
99
- afterEach(() => {
100
- cleanup();
101
- });
102
-
103
100
  test('Renders with children', async () => {
104
101
  render(
105
102
  <ClientProvider client={client}>
@@ -151,7 +148,7 @@ describe('ClientProvider', () => {
151
148
 
152
149
  await act(async () => {
153
150
  await waitForCondition({
154
- condition: () => !client.initialized && newClient.status.get() === SystemStatus.ACTIVE,
151
+ condition: () => newClient.status.get() === SystemStatus.ACTIVE && !client.initialized,
155
152
  });
156
153
  });
157
154
  expect(client.initialized).toBe(false);
@@ -2,18 +2,12 @@
2
2
  // Copyright 2020 DXOS.org
3
3
  //
4
4
 
5
- import React, {
6
- type FunctionComponent,
7
- type PropsWithChildren,
8
- forwardRef,
9
- useEffect,
10
- useImperativeHandle,
11
- useState,
12
- } from 'react';
5
+ import React, { type FunctionComponent, type ReactNode, useEffect, useMemo, useState } from 'react';
13
6
 
14
7
  import { Client, type ClientOptions, type ClientServicesProvider, SystemStatus } from '@dxos/client';
15
8
  import { type Config } from '@dxos/config';
16
- import { registerSignalsRuntime } from '@dxos/echo-signals/react';
9
+ import { type S } from '@dxos/echo-schema';
10
+ import { registerSignalFactory } from '@dxos/echo-signals/react';
17
11
  import { log } from '@dxos/log';
18
12
  import { useControlledValue } from '@dxos/react-hooks';
19
13
  import { getAsyncProviderValue, type MaybePromise, type Provider } from '@dxos/util';
@@ -24,47 +18,47 @@ import { printBanner } from '../banner';
24
18
  /**
25
19
  * Properties for the ClientProvider.
26
20
  */
27
- export type ClientProviderProps = Omit<ClientOptions, 'config' | 'services'> &
28
- Pick<ClientContextProps, 'status'> &
29
- PropsWithChildren<{
21
+ export type ClientProviderProps = Pick<ClientContextProps, 'status'> &
22
+ Omit<ClientOptions, 'config' | 'services'> & {
23
+ children?: ReactNode;
24
+
30
25
  /**
31
- * Client object or async provider to enable to caller to do custom initialization.
32
- *
33
- * NOTE: For advanced use cases only.
26
+ * Config object or async provider.
34
27
  */
35
- client?: Client | Provider<Promise<Client>>;
28
+ config?: Config | Provider<Promise<Config>>;
36
29
 
37
30
  /**
38
- * Config object or async provider.
31
+ * Client object or async provider to enable to caller to do custom initialization.
39
32
  *
40
- * NOTE: If a `client` is provided then `config` is ignored.
33
+ * Most apps won't need this.
41
34
  */
42
- // TODO(burdon): Reconcile with ClientOptions.
43
- config?: Config | Provider<Promise<Config>>;
35
+ // TODO(wittjosiah): Remove async and just use to keep reference to client?
36
+ // (Preferring `onInitialized` for custom initialization.)
37
+ // TODO(burdon): Use useImperativeHandle to expose client.
38
+ client?: Client | Provider<Promise<Client>>;
44
39
 
45
40
  /**
46
41
  * Callback to enable the caller to create a custom ClientServicesProvider.
47
42
  *
48
- * NOTE: If a `client` is provided then `services` is ignored.
43
+ * Most apps won't need this.
49
44
  */
50
- // TODO(burdon): Reconcile with ClientOptions.
51
45
  services?: ClientServicesProvider | ((config?: Config) => MaybePromise<ClientServicesProvider>);
52
46
 
53
47
  /**
54
- * ReactNode to display until the client is available.
48
+ * List of schema to register.
55
49
  */
56
- fallback?: FunctionComponent<Partial<ClientContextProps>>;
50
+ types?: S.Schema<any>[];
57
51
 
58
52
  /**
59
- * Enable (by default) registration of Preact signals runtime for reactive ECHO objects.
60
- * @see https://www.npmjs.com/package/@preact/signals-react
53
+ * ReactNode to display until the client is available.
61
54
  */
62
- signalsRuntime?: boolean;
55
+ fallback?: FunctionComponent<Partial<ClientContextProps>>;
63
56
 
64
57
  /**
65
- * Skip the DXOS banner.
58
+ * Set to false to stop default signal factory from being registered.
66
59
  */
67
- noBanner?: boolean;
60
+ // TODO(burdon): Move to options.
61
+ registerSignalFactory?: boolean;
68
62
 
69
63
  /**
70
64
  * Post initialization hook to enable to caller to do custom initialization.
@@ -72,111 +66,91 @@ export type ClientProviderProps = Omit<ClientOptions, 'config' | 'services'> &
72
66
  * @param Client
73
67
  */
74
68
  onInitialized?: (client: Client) => MaybePromise<void>;
75
- }>;
69
+ };
76
70
 
77
71
  /**
78
72
  * Root component that provides the DXOS client instance to child components.
79
73
  * To be used with the `useClient` hook.
80
74
  */
81
- export const ClientProvider = forwardRef<Client | undefined, ClientProviderProps>(
82
- (
83
- {
84
- children,
85
- config: configProvider,
86
- client: clientProvider,
87
- services: servicesProvider,
88
- status: controlledStatus,
89
- fallback: Fallback = () => null,
90
- signalsRuntime = true,
91
- noBanner,
92
- onInitialized,
93
- ...options
94
- },
95
- forwardedRef,
96
- ) => {
97
- useEffect(() => {
98
- // TODO(wittjosiah): Ideally this should be imported asynchronously because it is optional.
99
- // Unfortunately, async import seemed to break signals React instrumentation.
100
- signalsRuntime && registerSignalsRuntime();
101
- }, []);
102
-
103
- // The client is initialized asynchronously.
104
- // If an error occurs during initialization, it is caught and the state is set.
105
- // This allows the error to be thrown in the render method.
106
- // The assumption is that a client initialization error is fatal to the app.
107
- // This error will be caught by the nearest error boundary.
108
- const [error, setError] = useState();
109
- if (error) {
110
- throw error;
75
+ export const ClientProvider = ({
76
+ children,
77
+ config: configProvider,
78
+ client: clientProvider,
79
+ services: servicesProvider,
80
+ types,
81
+ status: controlledStatus,
82
+ fallback: Fallback = () => null,
83
+ registerSignalFactory: _registerSignalFactory = true,
84
+ onInitialized,
85
+ ...options
86
+ }: ClientProviderProps) => {
87
+ useMemo(() => {
88
+ // TODO(wittjosiah): Ideally this should be imported asynchronously because it is optional.
89
+ // Unfortunately, async import seemed to break signals React instrumentation.
90
+ _registerSignalFactory && registerSignalFactory();
91
+ }, []);
92
+
93
+ const [client, setClient] = useState(clientProvider instanceof Client ? clientProvider : undefined);
94
+
95
+ const [error, setError] = useState();
96
+ if (error) {
97
+ throw error;
98
+ }
99
+
100
+ // Status subscription.
101
+ const [status, setStatus] = useControlledValue(controlledStatus);
102
+ useEffect(() => {
103
+ if (!client) {
104
+ return;
111
105
  }
112
106
 
113
- const [client, setClient] = useState(clientProvider instanceof Client ? clientProvider : undefined);
114
-
115
- // Provide external access.
116
- useImperativeHandle(forwardedRef, () => client, [client]);
107
+ const subscription = client.status.subscribe((status) => setStatus(status));
108
+ return () => subscription.unsubscribe();
109
+ }, [client, setStatus]);
110
+
111
+ // Initialize client.
112
+ useEffect(() => {
113
+ const done = async (client: Client) => {
114
+ await client.initialize().catch(setError);
115
+ log('client ready');
116
+ await onInitialized?.(client);
117
+ log('initialization complete');
118
+ if (types) {
119
+ client.addTypes(types);
120
+ }
117
121
 
118
- // Client status subscription.
119
- const [status, setStatus] = useControlledValue(controlledStatus);
120
- useEffect(() => {
121
- if (!client) {
122
- return;
122
+ setClient(client);
123
+ setStatus(client.status.get() ?? SystemStatus.ACTIVE);
124
+ printBanner(client);
125
+ };
126
+
127
+ const t = setTimeout(async () => {
128
+ if (clientProvider) {
129
+ // Asynchronously request client.
130
+ const client = await getAsyncProviderValue(clientProvider);
131
+ await done(client);
132
+ } else {
133
+ // Asynchronously construct client (config may be undefined).
134
+ const config = await getAsyncProviderValue(configProvider);
135
+ log('resolved config', { config });
136
+ const services = await getAsyncProviderValue(servicesProvider, config);
137
+ log('created services', { services });
138
+ const client = new Client({ config, services, ...options });
139
+ log('created client');
140
+ await done(client);
123
141
  }
142
+ });
124
143
 
125
- const subscription = client.status.subscribe((status) => setStatus(status));
126
- return () => subscription.unsubscribe();
127
- }, [client]);
128
-
129
- // Create and/or initialize client.
130
- useEffect(() => {
131
- const initialize = async (client: Client) => {
132
- if (!client.initialized) {
133
- await client.initialize().catch(setError);
134
- log('client ready');
135
- await onInitialized?.(client);
136
- log('initialization complete');
137
- }
138
-
139
- setClient(client);
140
-
141
- if (!noBanner) {
142
- printBanner(client);
143
- }
144
- };
145
-
146
- let client: Client;
147
- const t = setTimeout(async () => {
148
- if (clientProvider) {
149
- // Asynchronously request client.
150
- client = await getAsyncProviderValue(clientProvider);
151
- await initialize(client);
152
- } else {
153
- // Asynchronously construct client (config may be undefined).
154
- const config = await getAsyncProviderValue(configProvider);
155
- log('resolved config', { config });
156
- const services = await getAsyncProviderValue(servicesProvider, config);
157
- log('created services', { services });
158
- client = new Client({ config, services, ...options });
159
- log('created client');
160
- await initialize(client);
161
- }
162
- });
163
-
164
- return () => {
165
- log('clean up');
166
- clearTimeout(t);
167
- void client
168
- ?.destroy()
169
- .then(() => {
170
- log('destroyed');
171
- })
172
- .catch((err) => log.catch(err));
173
- };
174
- }, [configProvider, clientProvider, servicesProvider, noBanner]);
175
-
176
- if (!client?.initialized || status !== SystemStatus.ACTIVE) {
177
- return <Fallback client={client} status={status} />;
178
- }
144
+ return () => {
145
+ log('clean up');
146
+ clearTimeout(t);
147
+ void client?.destroy().catch((err) => log.catch(err));
148
+ };
149
+ }, [clientProvider, configProvider, servicesProvider]);
150
+
151
+ if (!client || status !== SystemStatus.ACTIVE) {
152
+ return <Fallback client={client} status={status} />;
153
+ }
179
154
 
180
- return <ClientContext.Provider value={{ client, status }}>{children}</ClientContext.Provider>;
181
- },
182
- );
155
+ return <ClientContext.Provider value={{ client, status }}>{children}</ClientContext.Provider>;
156
+ };