@dxos/client-protocol 0.8.4-main.b97322e → 0.8.4-main.bcb3aa67d6

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 (50) hide show
  1. package/dist/lib/browser/chunk-XZ3UMPW2.mjs +40 -0
  2. package/dist/lib/browser/chunk-XZ3UMPW2.mjs.map +7 -0
  3. package/dist/lib/browser/index.mjs +47 -35
  4. package/dist/lib/browser/index.mjs.map +4 -4
  5. package/dist/lib/browser/meta.json +1 -1
  6. package/dist/lib/browser/types/index.mjs +11 -0
  7. package/dist/lib/browser/types/index.mjs.map +7 -0
  8. package/dist/lib/node-esm/chunk-3LD3QH4M.mjs +42 -0
  9. package/dist/lib/node-esm/chunk-3LD3QH4M.mjs.map +7 -0
  10. package/dist/lib/node-esm/index.mjs +46 -35
  11. package/dist/lib/node-esm/index.mjs.map +4 -4
  12. package/dist/lib/node-esm/meta.json +1 -1
  13. package/dist/lib/node-esm/types/index.mjs +12 -0
  14. package/dist/lib/node-esm/types/index.mjs.map +7 -0
  15. package/dist/types/src/config.d.ts +24 -8
  16. package/dist/types/src/config.d.ts.map +1 -1
  17. package/dist/types/src/echo.d.ts +9 -23
  18. package/dist/types/src/echo.d.ts.map +1 -1
  19. package/dist/types/src/halo.d.ts +1 -1
  20. package/dist/types/src/halo.d.ts.map +1 -1
  21. package/dist/types/src/index.d.ts +3 -3
  22. package/dist/types/src/index.d.ts.map +1 -1
  23. package/dist/types/src/{service-definitions.d.ts → service.d.ts} +18 -7
  24. package/dist/types/src/service.d.ts.map +1 -0
  25. package/dist/types/src/shell.d.ts +1 -1
  26. package/dist/types/src/shell.d.ts.map +1 -1
  27. package/dist/types/src/space.d.ts +40 -16
  28. package/dist/types/src/space.d.ts.map +1 -1
  29. package/dist/types/src/timeouts.d.ts +4 -0
  30. package/dist/types/src/timeouts.d.ts.map +1 -1
  31. package/dist/types/src/types/SpaceProperties.d.ts +39 -0
  32. package/dist/types/src/types/SpaceProperties.d.ts.map +1 -0
  33. package/dist/types/src/types/index.d.ts +2 -0
  34. package/dist/types/src/types/index.d.ts.map +1 -0
  35. package/dist/types/tsconfig.tsbuildinfo +1 -1
  36. package/package.json +31 -19
  37. package/src/config.ts +33 -14
  38. package/src/echo.ts +10 -31
  39. package/src/halo.ts +1 -1
  40. package/src/index.ts +3 -3
  41. package/src/{service-definitions.ts → service.ts} +26 -12
  42. package/src/shell.ts +1 -1
  43. package/src/space.ts +61 -26
  44. package/src/timeouts.ts +5 -0
  45. package/src/types/SpaceProperties.ts +59 -0
  46. package/src/types/index.ts +5 -0
  47. package/dist/types/src/schema.d.ts +0 -27
  48. package/dist/types/src/schema.d.ts.map +0 -1
  49. package/dist/types/src/service-definitions.d.ts.map +0 -1
  50. package/src/schema.ts +0 -28
package/package.json CHANGED
@@ -1,47 +1,59 @@
1
1
  {
2
2
  "name": "@dxos/client-protocol",
3
- "version": "0.8.4-main.b97322e",
3
+ "version": "0.8.4-main.bcb3aa67d6",
4
4
  "description": "Core DXOS Client API.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
7
- "repository": "github:dxos/dxos",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "https://github.com/dxos/dxos"
10
+ },
8
11
  "license": "MIT",
9
12
  "author": "DXOS.org",
10
- "sideEffects": true,
13
+ "sideEffects": false,
11
14
  "type": "module",
12
15
  "exports": {
13
16
  ".": {
17
+ "source": "./src/index.ts",
14
18
  "types": "./dist/types/src/index.d.ts",
15
19
  "browser": "./dist/lib/browser/index.mjs",
16
20
  "node": "./dist/lib/node-esm/index.mjs"
21
+ },
22
+ "./types": {
23
+ "source": "./src/types/index.ts",
24
+ "types": "./dist/types/src/types/index.d.ts",
25
+ "browser": "./dist/lib/browser/types/index.mjs",
26
+ "node": "./dist/lib/node-esm/types/index.mjs"
17
27
  }
18
28
  },
19
29
  "types": "dist/types/src/index.d.ts",
20
30
  "typesVersions": {
21
- "*": {}
31
+ "*": {
32
+ "./types": [
33
+ "./dist/types/src/types/index.d.ts"
34
+ ]
35
+ }
22
36
  },
23
37
  "files": [
24
38
  "dist",
25
39
  "src"
26
40
  ],
27
41
  "dependencies": {
28
- "base-x": "~3.0.9",
29
- "effect": "3.17.0",
30
- "@dxos/async": "0.8.4-main.b97322e",
31
- "@dxos/config": "0.8.4-main.b97322e",
32
- "@dxos/context": "0.8.4-main.b97322e",
33
- "@dxos/credentials": "0.8.4-main.b97322e",
34
- "@dxos/echo": "0.8.4-main.b97322e",
35
- "@dxos/echo-db": "0.8.4-main.b97322e",
36
- "@dxos/echo-schema": "0.8.4-main.b97322e",
37
- "@dxos/invariant": "0.8.4-main.b97322e",
38
- "@dxos/node-std": "0.8.4-main.b97322e",
39
- "@dxos/keys": "0.8.4-main.b97322e",
40
- "@dxos/protocols": "0.8.4-main.b97322e",
41
- "@dxos/rpc": "0.8.4-main.b97322e"
42
+ "base-x": "~3.0.11",
43
+ "effect": "3.20.0",
44
+ "@dxos/async": "0.8.4-main.bcb3aa67d6",
45
+ "@dxos/credentials": "0.8.4-main.bcb3aa67d6",
46
+ "@dxos/echo": "0.8.4-main.bcb3aa67d6",
47
+ "@dxos/echo-db": "0.8.4-main.bcb3aa67d6",
48
+ "@dxos/invariant": "0.8.4-main.bcb3aa67d6",
49
+ "@dxos/keys": "0.8.4-main.bcb3aa67d6",
50
+ "@dxos/node-std": "0.8.4-main.bcb3aa67d6",
51
+ "@dxos/protocols": "0.8.4-main.bcb3aa67d6",
52
+ "@dxos/rpc": "0.8.4-main.bcb3aa67d6",
53
+ "@dxos/context": "0.8.4-main.bcb3aa67d6"
42
54
  },
43
55
  "peerDependencies": {
44
- "effect": "^3.13.3"
56
+ "effect": "3.20.0"
45
57
  },
46
58
  "publishConfig": {
47
59
  "access": "public"
package/src/config.ts CHANGED
@@ -2,10 +2,10 @@
2
2
  // Copyright 2022 DXOS.org
3
3
  //
4
4
 
5
- import { type ConfigProto } from '@dxos/config';
5
+ // TODO(wittjosiah): Factor out to @dxos/config.
6
6
 
7
- export const DEFAULT_INTERNAL_CHANNEL = 'dxos:vault';
8
7
  export const DEFAULT_CLIENT_CHANNEL = 'dxos:app';
8
+ export const DEFAULT_INTERNAL_CHANNEL = 'dxos:vault';
9
9
  export const DEFAULT_SHELL_CHANNEL = 'dxos:shell';
10
10
  export const DEFAULT_WORKER_BROADCAST_CHANNEL = 'dxos:shared-worker';
11
11
 
@@ -14,19 +14,18 @@ export const DEFAULT_WORKER_BROADCAST_CHANNEL = 'dxos:shared-worker';
14
14
  */
15
15
  export const DEFAULT_VAULT_URL = 'https://halo.dxos.org/vault.html';
16
16
 
17
+ /**
18
+ * @deprecated
19
+ */
20
+ // TODO(burdon): Remove need (i.e., make undefined do the right thing).
21
+ export const DEFAULT_PROFILE = 'default';
22
+
17
23
  export const EXPECTED_CONFIG_VERSION = 1;
18
- export const defaultConfig: ConfigProto = { version: 1 };
24
+ export const defaultConfig = { version: 1 };
19
25
 
20
26
  // TODO(burdon): Allow override via env? Generalize since currently NodeJS only.
21
27
  const HOME = typeof process !== 'undefined' ? (process?.env?.HOME ?? '') : '';
22
28
 
23
- // Base directories.
24
- // TODO(burdon): Consider Windows, Linux, OSX.
25
- // https://wiki.archlinux.org/title/XDG_Base_Directory
26
- // Each `/dx` directory should contain `/profile/<DX_PROFILE>` subdirectories.
27
- export const getProfilePath = (root: string, profile: string, file: string | undefined = undefined) =>
28
- `${root}/profile/${profile}` + (file ? `/${file}` : '');
29
-
30
29
  // XDG_CONFIG_HOME (Analogous to /etc.)
31
30
  export const DX_CONFIG = `${HOME}/.config/dx`;
32
31
 
@@ -43,7 +42,27 @@ export const DX_STATE = `${HOME}/.local/state/dx`;
43
42
  // XDG_RUNTIME_DIR (Non-essential files, sockets, etc.)
44
43
  export const DX_RUNTIME = '/tmp/dx/run';
45
44
 
46
- export const ENV_DX_CONFIG = 'DX_CONFIG';
47
- export const ENV_DX_NO_AGENT = 'DX_NO_AGENT';
48
- export const ENV_DX_PROFILE = 'DX_PROFILE';
49
- export const ENV_DX_PROFILE_DEFAULT = 'default';
45
+ export enum DXEnv {
46
+ CONFIG = 'DX_CONFIG',
47
+ DEBUG = 'DX_DEBUG',
48
+ NO_AGENT = 'DX_NO_AGENT',
49
+ PROFILE = 'DX_PROFILE',
50
+ }
51
+
52
+ export namespace DXEnv {
53
+ /**
54
+ * Helper to get the value from process.env
55
+ */
56
+ export function get(variable: DXEnv): string | undefined;
57
+ export function get(variable: DXEnv, defaultValue: string): string;
58
+ export function get(variable: DXEnv, defaultValue?: string): string | undefined {
59
+ return process.env[variable] ?? defaultValue;
60
+ }
61
+ }
62
+
63
+ // Profile layout: profile/<name> is the profile dir; profile/<name>.yml is the config file.
64
+ export const getProfilePath = (root: string, profile: string, file?: string) =>
65
+ `${root}/profile/${profile}` + (file ? `/${file}` : '');
66
+
67
+ /** Path to the profile config file (profile/<name>.yml). */
68
+ export const getProfileConfigPath = (root: string, profile: string) => `${getProfilePath(root, profile)}.yml`;
package/src/echo.ts CHANGED
@@ -3,32 +3,20 @@
3
3
  //
4
4
 
5
5
  import type { MulticastObservable } from '@dxos/async';
6
- import type { QueryFn } from '@dxos/echo-db';
6
+ import type { Database } from '@dxos/echo';
7
7
  import type { PublicKey, SpaceId } from '@dxos/keys';
8
8
  import type { Invitation, SpaceArchive } from '@dxos/protocols/proto/dxos/client/services';
9
+ import type { MembershipPolicy } from '@dxos/protocols/proto/dxos/halo/credentials';
9
10
 
10
11
  import type { AuthenticatingInvitation } from './invitations';
11
- import type { PropertiesTypeProps } from './schema';
12
12
  import type { Space } from './space';
13
+ import type { SpaceProperties } from './types';
13
14
 
14
15
  /**
15
- * TODO(burdon): Public API (move comments here).
16
+ * Public database API.
16
17
  */
17
- // TODO(wittjosiah): Rename?
18
- // https://ts.dev/style/#naming-style
19
- // ClientApi? ClientProtocol?
20
- export interface Echo extends MulticastObservable<Space[]> {
21
- /**
22
- * Resolves when the default space is available.
23
- */
24
- waitUntilReady(): Promise<void>;
25
-
26
- /**
27
- * Observable which indicates when the default space is available.
28
- */
29
- // TODO(wittjosiah): Remove. Ensure default space is always available.
30
- get isReady(): MulticastObservable<boolean>;
31
-
18
+ // TODO(wittjosiah): Rename Database (not product name).
19
+ export interface Echo extends MulticastObservable<Space[]>, Database.Queryable {
32
20
  /**
33
21
  * Returns the list of spaces.
34
22
  */
@@ -45,15 +33,13 @@ export interface Echo extends MulticastObservable<Space[]> {
45
33
  */
46
34
  get(spaceKey: PublicKey): Space | undefined;
47
35
 
48
- /**
49
- * Returns the default space.
50
- */
51
- get default(): Space;
52
-
53
36
  /**
54
37
  * Creates a new space.
55
38
  */
56
- create(meta?: PropertiesTypeProps): Promise<Space>;
39
+ create(
40
+ props?: Pick<SpaceProperties, 'name' | 'hue' | 'icon' | 'invocationTraceQueue'>,
41
+ options?: { tags?: string[]; membershipPolicy?: MembershipPolicy },
42
+ ): Promise<Space>;
57
43
 
58
44
  /**
59
45
  * Creates a space from the given archive.
@@ -66,11 +52,4 @@ export interface Echo extends MulticastObservable<Space[]> {
66
52
  join(invitation: Invitation | string): AuthenticatingInvitation;
67
53
 
68
54
  joinBySpaceKey(spaceKey: PublicKey): Promise<Space>;
69
-
70
- /**
71
- * Query all spaces.
72
- * @param filter
73
- * @param options
74
- */
75
- query: QueryFn;
76
55
  }
package/src/halo.ts CHANGED
@@ -6,8 +6,8 @@ import { type MulticastObservable } from '@dxos/async';
6
6
  import { type PublicKey } from '@dxos/keys';
7
7
  import { type Contact, type Device, type Identity, type Invitation } from '@dxos/protocols/proto/dxos/client/services';
8
8
  import {
9
- type DeviceProfileDocument,
10
9
  type Credential,
10
+ type DeviceProfileDocument,
11
11
  type Presentation,
12
12
  type ProfileDocument,
13
13
  } from '@dxos/protocols/proto/dxos/halo/credentials';
package/src/index.ts CHANGED
@@ -7,8 +7,8 @@ export * from './config';
7
7
  export type * from './echo';
8
8
  export type * from './halo';
9
9
  export * from './invitations';
10
- export * from './service-definitions';
10
+ export * from './service';
11
11
  export type * from './shell';
12
- export type * from './space';
12
+ export * from './space';
13
13
  export * from './timeouts';
14
- export * from './schema';
14
+ export * from './types';
@@ -4,17 +4,17 @@
4
4
 
5
5
  import { type Event } from '@dxos/async';
6
6
  import { schema } from '@dxos/protocols/proto';
7
- import type { FunctionRegistryService } from '@dxos/protocols/proto/dxos/agent/functions';
8
7
  import type {
8
+ ContactsService,
9
9
  DevicesService,
10
+ EdgeAgentService,
10
11
  IdentityService,
11
12
  InvitationsService,
12
13
  LoggingService,
13
14
  NetworkService,
15
+ QueueService,
14
16
  SpacesService,
15
17
  SystemService,
16
- ContactsService,
17
- EdgeAgentService,
18
18
  } from '@dxos/protocols/proto/dxos/client/services';
19
19
  import type { DevtoolsHost } from '@dxos/protocols/proto/dxos/devtools/host';
20
20
  import type { QueryService } from '@dxos/protocols/proto/dxos/echo/query';
@@ -24,6 +24,8 @@ import type { BridgeService } from '@dxos/protocols/proto/dxos/mesh/bridge';
24
24
  import type { TracingService } from '@dxos/protocols/proto/dxos/tracing';
25
25
  import { type ServiceBundle, createServiceBundle } from '@dxos/rpc';
26
26
 
27
+ export type { QueueService } from '@dxos/protocols/proto/dxos/client/services';
28
+
27
29
  //
28
30
  // NOTE: Should contain client/proxy dependencies only.
29
31
  //
@@ -35,15 +37,16 @@ export type ClientServices = {
35
37
 
36
38
  IdentityService: IdentityService;
37
39
  InvitationsService: InvitationsService;
38
- QueryService: QueryService;
39
40
  DevicesService: DevicesService;
40
41
  SpacesService: SpacesService;
42
+
41
43
  DataService: DataService;
44
+ QueryService: QueryService;
45
+ QueueService: QueueService;
46
+
42
47
  ContactsService: ContactsService;
43
48
  EdgeAgentService: EdgeAgentService;
44
49
 
45
- FunctionRegistryService: FunctionRegistryService;
46
-
47
50
  // TODO(burdon): Deprecated.
48
51
  DevtoolsHost: DevtoolsHost;
49
52
 
@@ -59,12 +62,26 @@ export interface ClientServicesProvider {
59
62
  * This should fire if the services disconnect unexpectedly or during a client reset.
60
63
  */
61
64
  closed: Event<Error | undefined>;
65
+
66
+ /**
67
+ * The underlying service connection was re-established.
68
+ * Fires after all reconnection callbacks have completed.
69
+ */
70
+ reconnected?: Event<void>;
71
+
72
+ /**
73
+ * Register a callback to be invoked when services reconnect.
74
+ * The callback should re-establish any RPC streams.
75
+ * Reconnection waits for all callbacks to complete before emitting `reconnected`.
76
+ */
77
+ onReconnect?: (callback: () => Promise<void>) => void;
78
+
62
79
  descriptors: ServiceBundle<ClientServices>;
63
80
  services: Partial<ClientServices>;
64
81
 
65
82
  // TODO(burdon): Should take context from parent?
66
- open(): Promise<void>;
67
- close(): Promise<void>;
83
+ open(): Promise<unknown>;
84
+ close(): Promise<unknown>;
68
85
  }
69
86
 
70
87
  /**
@@ -83,13 +100,10 @@ export const clientServiceBundle = createServiceBundle<ClientServices>({
83
100
  DataService: schema.getService('dxos.echo.service.DataService'),
84
101
  ContactsService: schema.getService('dxos.client.services.ContactsService'),
85
102
  EdgeAgentService: schema.getService('dxos.client.services.EdgeAgentService'),
86
-
87
- // Agent-only.
88
- FunctionRegistryService: schema.getService('dxos.agent.functions.FunctionRegistryService'),
103
+ QueueService: schema.getService('dxos.client.services.QueueService'),
89
104
 
90
105
  // TODO(burdon): Deprecated.
91
106
  DevtoolsHost: schema.getService('dxos.devtools.host.DevtoolsHost'),
92
-
93
107
  TracingService: schema.getService('dxos.tracing.TracingService'),
94
108
  });
95
109
 
package/src/shell.ts CHANGED
@@ -5,8 +5,8 @@
5
5
  import { type Event } from '@dxos/async';
6
6
  import { type PublicKey } from '@dxos/keys';
7
7
  import {
8
- type InvitationUrlRequest,
9
8
  type AppContextRequest,
9
+ type InvitationUrlRequest,
10
10
  type LayoutRequest,
11
11
  type ShellLayout,
12
12
  } from '@dxos/protocols/proto/dxos/iframe';
package/src/space.ts CHANGED
@@ -2,26 +2,30 @@
2
2
  // Copyright 2021 DXOS.org
3
3
  //
4
4
 
5
- import { type MulticastObservable, type CleanupFn } from '@dxos/async';
5
+ import * as Schema from 'effect/Schema';
6
+
7
+ import { type MulticastObservable } from '@dxos/async';
6
8
  import { type SpecificCredential } from '@dxos/credentials';
7
- import { type QueueFactory, type EchoDatabase, type AnyLiveObject } from '@dxos/echo-db';
9
+ import { type Database, type Obj } from '@dxos/echo';
10
+ import { type EchoDatabase, type QueueFactory, type SpaceSyncState } from '@dxos/echo-db';
8
11
  import { type PublicKey, type SpaceId } from '@dxos/keys';
12
+ import { type Messenger } from '@dxos/protocols';
9
13
  import {
10
14
  type Contact,
11
15
  type CreateEpochRequest,
12
16
  type Invitation,
13
- type Space as SpaceData,
14
17
  type SpaceArchive,
18
+ type Space as SpaceData,
15
19
  type SpaceMember,
16
20
  type SpaceState,
17
21
  type UpdateMemberRoleRequest,
18
22
  } from '@dxos/protocols/proto/dxos/client/services';
19
23
  import { type EdgeReplicationSetting } from '@dxos/protocols/proto/dxos/echo/metadata';
20
24
  import { type SpaceSnapshot } from '@dxos/protocols/proto/dxos/echo/snapshot';
21
- import { type Credential, type Epoch } from '@dxos/protocols/proto/dxos/halo/credentials';
22
- import { type GossipMessage } from '@dxos/protocols/proto/dxos/mesh/teleport/gossip';
25
+ import { type Credential, type Epoch, type MembershipPolicy } from '@dxos/protocols/proto/dxos/halo/credentials';
23
26
 
24
27
  import { type CancellableInvitation } from './invitations';
28
+ import { type SpaceProperties } from './types';
25
29
 
26
30
  export type CreateEpochOptions = {
27
31
  migration?: CreateEpochRequest.Migration;
@@ -29,17 +33,21 @@ export type CreateEpochOptions = {
29
33
  };
30
34
 
31
35
  export interface SpaceInternal {
36
+ get db(): EchoDatabase;
32
37
  get data(): SpaceData;
33
38
 
34
- // TODO(dmaretskyi): Return epoch info.
35
- createEpoch(options?: CreateEpochOptions): Promise<void>;
36
-
37
39
  getCredentials(): Promise<Credential[]>;
38
40
 
39
41
  getEpochs(): Promise<SpecificCredential<Epoch>[]>;
40
42
 
43
+ // TODO(dmaretskyi): Return epoch info.
44
+ createEpoch(options?: CreateEpochOptions): Promise<void>;
45
+
46
+ // TOOD(burdon): Start to factor out credentials.
41
47
  removeMember(memberKey: PublicKey): Promise<void>;
42
48
 
49
+ export(): Promise<SpaceArchive>;
50
+
43
51
  /**
44
52
  * Migrate space data to the latest version.
45
53
  */
@@ -47,37 +55,55 @@ export interface SpaceInternal {
47
55
 
48
56
  setEdgeReplicationPreference(setting: EdgeReplicationSetting): Promise<void>;
49
57
 
50
- export(): Promise<SpaceArchive>;
51
- }
52
-
53
- // TODO(burdon): Separate public API form implementation (move comments here).
54
- export interface Space {
55
58
  /**
56
- * Unique space identifier.
59
+ * Waits until the space is fully synced with EDGE.
60
+ * @throws If the EDGE sync is disabled.
57
61
  */
58
- get id(): SpaceId;
62
+ syncToEdge(opts?: {
63
+ onProgress: (state: SpaceSyncState.PeerState | undefined) => void;
64
+ timeout?: number;
65
+ }): Promise<void>;
66
+ }
67
+
68
+ export const SPACE_TAG = Symbol('dxos.client.protocol.Space');
69
+
70
+ export interface Space extends Messenger {
71
+ readonly [SPACE_TAG]: true;
59
72
 
60
73
  /**
61
74
  * @deprecated Use `id`.
62
75
  */
63
76
  get key(): PublicKey;
64
77
 
78
+ /**
79
+ * Unique space identifier.
80
+ */
81
+ get id(): SpaceId;
82
+
65
83
  /**
66
84
  * Echo database.
67
85
  */
68
- get db(): EchoDatabase;
86
+ get db(): Database.Database;
69
87
 
70
88
  /**
71
89
  * Access to queues.
72
90
  */
73
91
  get queues(): QueueFactory;
74
92
 
93
+ // TODO(burdon): Replace with state?
75
94
  get isOpen(): boolean;
76
95
 
77
96
  /**
78
- * Properties object.
97
+ * Immutable tags assigned at space creation time.
98
+ * Available on closed spaces.
79
99
  */
80
- get properties(): AnyLiveObject<any>;
100
+ get tags(): string[];
101
+
102
+ /**
103
+ * Immutable membership policy assigned at space creation time.
104
+ * Available on closed spaces.
105
+ */
106
+ get membershipPolicy(): MembershipPolicy;
81
107
 
82
108
  /**
83
109
  * Current state of the space.
@@ -86,6 +112,11 @@ export interface Space {
86
112
  */
87
113
  get state(): MulticastObservable<SpaceState>;
88
114
 
115
+ /**
116
+ * Properties object.
117
+ */
118
+ get properties(): Obj.OfShape<SpaceProperties>;
119
+
89
120
  /**
90
121
  * Current state of space pipeline.
91
122
  */
@@ -98,14 +129,14 @@ export interface Space {
98
129
  /**
99
130
  * @deprecated
100
131
  */
101
- // TODO(wittjosiah): Remove. This should not be exposed.
132
+ // TODO(wittjosiah): Audit and remove. This should not be exposed (or marked as internal).
102
133
  get internal(): SpaceInternal;
103
134
 
104
- // TODO(wittjosiah): Rename activate/deactivate?
105
135
  /**
106
136
  * Activates the space enabling the use of the database and starts replication with peers.
107
137
  * The setting is persisted on the local device.
108
138
  */
139
+ // TODO(wittjosiah): Rename activate/deactivate?
109
140
  open(): Promise<void>;
110
141
 
111
142
  /**
@@ -123,13 +154,17 @@ export interface Space {
123
154
  createSnapshot(): Promise<SpaceSnapshot>;
124
155
 
125
156
  // TODO(burdon): Create invitation?
157
+ // TODO(burdon): Factor out membership, etc.
126
158
  share(options?: Partial<Invitation>): CancellableInvitation;
127
-
128
159
  admitContact(contact: Contact): Promise<void>;
129
-
130
160
  updateMemberRole(request: Omit<UpdateMemberRoleRequest, 'spaceKey'>): Promise<void>;
131
-
132
- // TODO(wittjosiah): Gather into messaging abstraction?
133
- postMessage: (channel: string, message: any) => Promise<void>;
134
- listen: (channel: string, callback: (message: GossipMessage) => void) => CleanupFn;
135
161
  }
162
+
163
+ export const isSpace = (object: unknown): object is Space =>
164
+ typeof object === 'object' && object != null && (object as Space)[SPACE_TAG] === true;
165
+
166
+ // TODO(burdon): Create lower-level definition (HasId, db, etc.) and move to @dxos/echo.
167
+ export const SpaceSchema: Schema.Schema<Space> = Schema.Any.pipe(
168
+ Schema.filter((space) => isSpace(space)),
169
+ Schema.annotations({ title: 'Space' }),
170
+ );
package/src/timeouts.ts CHANGED
@@ -33,6 +33,11 @@ export const LOAD_PROPERTIES_TIMEOUT = 3_000;
33
33
  */
34
34
  export const CREATE_SPACE_TIMEOUT = 5_000;
35
35
 
36
+ /**
37
+ * Timeout for creating new spaces.
38
+ */
39
+ export const IMPORT_SPACE_TIMEOUT = 30_000;
40
+
36
41
  /**
37
42
  * Timeout for loading of control feeds.
38
43
  */
@@ -0,0 +1,59 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ import * as Schema from 'effect/Schema';
6
+
7
+ import { Annotation, Ref, Type } from '@dxos/echo';
8
+ import { Queue } from '@dxos/echo-db';
9
+
10
+ export const SpacePropertiesSchema = Schema.Struct(
11
+ {
12
+ //
13
+ // System properties.
14
+ //
15
+
16
+ archived: Schema.optional(Schema.Boolean.annotations({ title: 'Archive Space' })),
17
+ // TODO(burdon): Change to mode (no booleans?)
18
+ // TODO(wittjosiah): Make optional with default value.
19
+ edgeReplication: Schema.optional(Schema.Boolean),
20
+ invocationTraceQueue: Schema.optional(Ref.Ref(Queue)),
21
+
22
+ //
23
+ // User properties.
24
+ //
25
+
26
+ name: Schema.optional(Schema.String),
27
+ icon: Schema.optional(Schema.String),
28
+ hue: Schema.optional(Schema.String),
29
+ },
30
+ {
31
+ key: Schema.String,
32
+ value: Schema.Any,
33
+ },
34
+ );
35
+
36
+ export type SpacePropertiesSchema = Schema.Schema.Type<typeof SpacePropertiesSchema>;
37
+
38
+ /** @deprecated Use SpaceProperties instead. */
39
+ export const LegacySpaceProperties = SpacePropertiesSchema.pipe(
40
+ Type.object({
41
+ typename: 'org.dxos.type.space-properties',
42
+ version: '0.1.0',
43
+ }),
44
+ Annotation.SystemTypeAnnotation.set(true),
45
+ );
46
+
47
+ export interface LegacySpaceProperties extends Schema.Schema.Type<typeof LegacySpaceProperties> {}
48
+
49
+ // TODO(burdon): Pipe Schem.optional, or partial to entire struct to make everything optional?
50
+ // TODO(burdon): Is separate schema def required for forms? Can it be extracted from SpaceProperties?
51
+ export const SpaceProperties = SpacePropertiesSchema.pipe(
52
+ Type.object({
53
+ typename: 'org.dxos.type.spaceProperties',
54
+ version: '0.1.0',
55
+ }),
56
+ Annotation.SystemTypeAnnotation.set(true),
57
+ );
58
+
59
+ export interface SpaceProperties extends Schema.Schema.Type<typeof SpaceProperties> {}
@@ -0,0 +1,5 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ export * from './SpaceProperties';
@@ -1,27 +0,0 @@
1
- import { Schema } from 'effect';
2
- import { Type } from '@dxos/echo';
3
- export declare const TYPE_PROPERTIES = "dxos.org/type/Properties";
4
- declare const PropertiesType_base: import("@dxos/echo-schema").TypedObjectPrototype<import("@dxos/echo-schema").TypedObjectFields<{
5
- name: Schema.optional<typeof Schema.String>;
6
- hue: Schema.optional<typeof Schema.String>;
7
- icon: Schema.optional<typeof Schema.String>;
8
- invocationTraceQueue: Schema.optional<Type.ref<Schema.Schema<Type.Expando, {
9
- [x: string]: any;
10
- id: string;
11
- }, never>>>;
12
- }, {
13
- record: true;
14
- }>, Schema.Struct.Encoded<{
15
- name: Schema.optional<typeof Schema.String>;
16
- hue: Schema.optional<typeof Schema.String>;
17
- icon: Schema.optional<typeof Schema.String>;
18
- invocationTraceQueue: Schema.optional<Type.ref<Schema.Schema<Type.Expando, {
19
- [x: string]: any;
20
- id: string;
21
- }, never>>>;
22
- }>>;
23
- export declare class PropertiesType extends PropertiesType_base {
24
- }
25
- export type PropertiesTypeProps = Pick<PropertiesType, 'name' | 'hue' | 'icon' | 'invocationTraceQueue'>;
26
- export {};
27
- //# sourceMappingURL=schema.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../src/schema.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAGlC,eAAO,MAAM,eAAe,6BAA6B,CAAC;;;;;;;;;;;;;;;;;;;;AAG1D,qBAAa,cAAe,SAAQ,mBAYnC;CAAG;AAGJ,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,cAAc,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,sBAAsB,CAAC,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"service-definitions.d.ts","sourceRoot":"","sources":["../../../src/service-definitions.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AAC1F,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,cAAc,EACd,aAAa,EACb,aAAa,EACb,eAAe,EACf,gBAAgB,EACjB,MAAM,4CAA4C,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AAC3E,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AACjG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,WAAW,CAAC;AAMpE,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,EAAE,aAAa,CAAC;IAC7B,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAE/B,eAAe,EAAE,eAAe,CAAC;IACjC,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,YAAY,EAAE,YAAY,CAAC;IAC3B,cAAc,EAAE,cAAc,CAAC;IAC/B,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,eAAe,CAAC;IACjC,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,uBAAuB,EAAE,uBAAuB,CAAC;IAGjD,YAAY,EAAE,YAAY,CAAC;IAE3B,cAAc,EAAE,cAAc,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;IACjC,WAAW,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAC3C,QAAQ,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAGlC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,+BAqB9B,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,aAAa,CAAC,mBAAmB,CAElE,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,aAAa,CAAC,mBAAmB,CAElE,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,aAAa,CAAC,gBAAgB,CAE5D,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,aAAa,CAAC,kBAAkB,CAEhE,CAAC"}
package/src/schema.ts DELETED
@@ -1,28 +0,0 @@
1
- //
2
- // Copyright 2024 DXOS.org
3
- //
4
-
5
- import { Schema } from 'effect';
6
-
7
- import { Type } from '@dxos/echo';
8
- import { TypedObject } from '@dxos/echo-schema';
9
-
10
- export const TYPE_PROPERTIES = 'dxos.org/type/Properties';
11
-
12
- // TODO(burdon): Factor out (co-locate with TYPE_PROPERTIES).
13
- export class PropertiesType extends TypedObject({
14
- typename: TYPE_PROPERTIES,
15
- version: '0.1.0',
16
- })(
17
- {
18
- name: Schema.optional(Schema.String),
19
- // TODO(wittjosiah): Make generic?
20
- hue: Schema.optional(Schema.String),
21
- icon: Schema.optional(Schema.String),
22
- invocationTraceQueue: Schema.optional(Type.Ref(Type.Expando)),
23
- },
24
- { record: true },
25
- ) {}
26
-
27
- // TODO(burdon): Remove? Use PropertiesType instead?
28
- export type PropertiesTypeProps = Pick<PropertiesType, 'name' | 'hue' | 'icon' | 'invocationTraceQueue'>;