@dxos/client-protocol 0.8.4-main.c4373fc → 0.8.4-main.c85a9c8dae

package/dist/types/src/space.d.ts

@@ -1,58 +1,72 @@
-import { type CleanupFn, type MulticastObservable } from '@dxos/async';
+import * as Schema from 'effect/Schema';
+import { type MulticastObservable } from '@dxos/async';
 import { type SpecificCredential } from '@dxos/credentials';
-import { type AnyLiveObject, type EchoDatabase, type QueueFactory } from '@dxos/echo-db';
+import { type Database, type Obj } from '@dxos/echo';
+import { type EchoDatabase, type QueueFactory, type SpaceSyncState } from '@dxos/echo-db';
 import { type PublicKey, type SpaceId } from '@dxos/keys';
+import { type Messenger } from '@dxos/protocols';
 import { type Contact, type CreateEpochRequest, type Invitation, type SpaceArchive, type Space as SpaceData, type SpaceMember, type SpaceState, type UpdateMemberRoleRequest } from '@dxos/protocols/proto/dxos/client/services';
 import { type EdgeReplicationSetting } from '@dxos/protocols/proto/dxos/echo/metadata';
 import { type SpaceSnapshot } from '@dxos/protocols/proto/dxos/echo/snapshot';
 import { type Credential, type Epoch } from '@dxos/protocols/proto/dxos/halo/credentials';
-import { type GossipMessage } from '@dxos/protocols/proto/dxos/mesh/teleport/gossip';
 import { type CancellableInvitation } from './invitations';
+import { type SpaceProperties } from './types';
 export type CreateEpochOptions = {
     migration?: CreateEpochRequest.Migration;
     automergeRootUrl?: string;
 };
 export interface SpaceInternal {
+    get db(): EchoDatabase;
     get data(): SpaceData;
-    createEpoch(options?: CreateEpochOptions): Promise<void>;
     getCredentials(): Promise<Credential[]>;
     getEpochs(): Promise<SpecificCredential<Epoch>[]>;
+    createEpoch(options?: CreateEpochOptions): Promise<void>;
     removeMember(memberKey: PublicKey): Promise<void>;
+    export(): Promise<SpaceArchive>;
     /**
      * Migrate space data to the latest version.
      */
     migrate(): Promise<void>;
     setEdgeReplicationPreference(setting: EdgeReplicationSetting): Promise<void>;
-    export(): Promise<SpaceArchive>;
-}
-export interface Space {
     /**
-     * Unique space identifier.
+     * Waits until the space is fully synced with EDGE.
+     * @throws If the EDGE sync is disabled.
      */
-    get id(): SpaceId;
+    syncToEdge(opts?: {
+        onProgress: (state: SpaceSyncState.PeerState | undefined) => void;
+        timeout?: number;
+    }): Promise<void>;
+}
+export declare const SPACE_TAG: unique symbol;
+export interface Space extends Messenger {
+    readonly [SPACE_TAG]: true;
     /**
      * @deprecated Use `id`.
      */
     get key(): PublicKey;
+    /**
+     * Unique space identifier.
+     */
+    get id(): SpaceId;
     /**
      * Echo database.
      */
-    get db(): EchoDatabase;
+    get db(): Database.Database;
     /**
      * Access to queues.
      */
     get queues(): QueueFactory;
     get isOpen(): boolean;
-    /**
-     * Properties object.
-     */
-    get properties(): AnyLiveObject<any>;
     /**
      * Current state of the space.
      * The database is ready to be used in `SpaceState.SPACE_READY` state.
      * Presence is available in `SpaceState.SPACE_CONTROL_ONLY` state.
      */
     get state(): MulticastObservable<SpaceState>;
+    /**
+     * Properties object.
+     */
+    get properties(): Obj.OfShape<SpaceProperties>;
     /**
      * Current state of space pipeline.
      */
@@ -82,7 +96,7 @@ export interface Space {
     share(options?: Partial<Invitation>): CancellableInvitation;
     admitContact(contact: Contact): Promise<void>;
     updateMemberRole(request: Omit<UpdateMemberRoleRequest, 'spaceKey'>): Promise<void>;
-    postMessage: (channel: string, message: any) => Promise<void>;
-    listen: (channel: string, callback: (message: GossipMessage) => void) => CleanupFn;
 }
+export declare const isSpace: (object: unknown) => object is Space;
+export declare const SpaceSchema: Schema.Schema<Space>;
 //# sourceMappingURL=space.d.ts.map

package/dist/types/src/space.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"space.d.ts","sourceRoot":"","sources":["../../../src/space.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,KAAK,YAAY,EAAE,MAAM,eAAe,CAAC;AACzF,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,kBAAkB,EACvB,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,KAAK,IAAI,SAAS,EACvB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,uBAAuB,EAC7B,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AACvF,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,0CAA0C,CAAC;AAC9E,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,KAAK,EAAE,MAAM,6CAA6C,CAAC;AAC1F,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,iDAAiD,CAAC;AAErF,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC;IACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,IAAI,IAAI,IAAI,SAAS,CAAC;IAGtB,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,cAAc,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAExC,SAAS,IAAI,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAElD,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,4BAA4B,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7E,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;CACjC;AAGD,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,IAAI,EAAE,IAAI,OAAO,CAAC;IAElB;;OAEG;IACH,IAAI,GAAG,IAAI,SAAS,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,IAAI,YAAY,CAAC;IAEvB;;OAEG;IACH,IAAI,MAAM,IAAI,YAAY,CAAC;IAE3B,IAAI,MAAM,IAAI,OAAO,CAAC;IAEtB;;OAEG;IACH,IAAI,UAAU,IAAI,aAAa,CAAC,GAAG,CAAC,CAAC;IAErC;;;;OAIG;IACH,IAAI,KAAK,IAAI,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAE7C;;OAEG;IACH,IAAI,QAAQ,IAAI,mBAAmB,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAE7D,IAAI,WAAW,IAAI,mBAAmB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAEhE,IAAI,OAAO,IAAI,mBAAmB,CAAC,WAAW,EAAE,CAAC,CAAC;IAElD;;OAEG;IAEH,IAAI,QAAQ,IAAI,aAAa,CAAC;IAG9B;;;OAGG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;OAEG;IACH,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC,cAAc,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IAGzC,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,qBAAqB,CAAC;IAE5D,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,uBAAuB,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAGpF,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9D,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,KAAK,SAAS,CAAC;CACpF"}
+{"version":3,"file":"space.d.ts","sourceRoot":"","sources":["../../../src/space.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,YAAY,EAAE,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAC1F,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,kBAAkB,EACvB,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,KAAK,IAAI,SAAS,EACvB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,uBAAuB,EAC7B,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AACvF,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,0CAA0C,CAAC;AAC9E,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,KAAK,EAAE,MAAM,6CAA6C,CAAC;AAE1F,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAC3D,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC;IACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,IAAI,YAAY,CAAC;IACvB,IAAI,IAAI,IAAI,SAAS,CAAC;IAEtB,cAAc,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAExC,SAAS,IAAI,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAGlD,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAGzD,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;IAEhC;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,4BAA4B,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7E;;;OAGG;IACH,UAAU,CAAC,IAAI,CAAC,EAAE;QAChB,UAAU,EAAE,CAAC,KAAK,EAAE,cAAc,CAAC,SAAS,GAAG,SAAS,KAAK,IAAI,CAAC;QAClE,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnB;AAED,eAAO,MAAM,SAAS,eAAuC,CAAC;AAE9D,MAAM,WAAW,KAAM,SAAQ,SAAS;IACtC,QAAQ,CAAC,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,GAAG,IAAI,SAAS,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,IAAI,OAAO,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,IAAI,QAAQ,CAAC,QAAQ,CAAC;IAE5B;;OAEG;IACH,IAAI,MAAM,IAAI,YAAY,CAAC;IAG3B,IAAI,MAAM,IAAI,OAAO,CAAC;IAEtB;;;;OAIG;IACH,IAAI,KAAK,IAAI,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAE7C;;OAEG;IACH,IAAI,UAAU,IAAI,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAE/C;;OAEG;IACH,IAAI,QAAQ,IAAI,mBAAmB,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAE7D,IAAI,WAAW,IAAI,mBAAmB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAEhE,IAAI,OAAO,IAAI,mBAAmB,CAAC,WAAW,EAAE,CAAC,CAAC;IAElD;;OAEG;IAEH,IAAI,QAAQ,IAAI,aAAa,CAAC;IAE9B;;;OAGG;IAEH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;OAEG;IACH,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC,cAAc,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IAIzC,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,qBAAqB,CAAC;IAC5D,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,uBAAuB,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrF;AAED,eAAO,MAAM,OAAO,GAAI,QAAQ,OAAO,KAAG,MAAM,IAAI,KACmC,CAAC;AAGxF,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAG5C,CAAC"}

package/dist/types/src/timeouts.d.ts

@@ -23,6 +23,10 @@ export declare const LOAD_PROPERTIES_TIMEOUT = 3000;
  * Timeout for creating new spaces.
  */
 export declare const CREATE_SPACE_TIMEOUT = 5000;
+/**
+ * Timeout for creating new spaces.
+ */
+export declare const IMPORT_SPACE_TIMEOUT = 30000;
 /**
  * Timeout for loading of control feeds.
  */

package/dist/types/src/timeouts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"timeouts.d.ts","sourceRoot":"","sources":["../../../src/timeouts.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,eAAO,MAAM,wBAAwB,QAAS,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,YAAY,QAAS,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,cAAc,QAAS,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,qBAAqB,OAAQ,CAAC;AAE3C;;;GAGG;AACH,eAAO,MAAM,uBAAuB,OAAQ,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,oBAAoB,OAAQ,CAAC;AAE1C;;GAEG;AACH,eAAO,MAAM,0BAA0B,OAAQ,CAAC"}
+{"version":3,"file":"timeouts.d.ts","sourceRoot":"","sources":["../../../src/timeouts.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,eAAO,MAAM,wBAAwB,QAAS,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,YAAY,QAAS,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,cAAc,QAAS,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,qBAAqB,OAAQ,CAAC;AAE3C;;;GAGG;AACH,eAAO,MAAM,uBAAuB,OAAQ,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,oBAAoB,OAAQ,CAAC;AAE1C;;GAEG;AACH,eAAO,MAAM,oBAAoB,QAAS,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,0BAA0B,OAAQ,CAAC"}

package/dist/types/src/types/SpaceProperties.d.ts

@@ -0,0 +1,27 @@
+import * as Schema from 'effect/Schema';
+import { Ref, Type } from '@dxos/echo';
+import { Queue } from '@dxos/echo-db';
+export declare const SpacePropertiesSchema: Schema.TypeLiteral<{
+    archived: Schema.optional<Schema.SchemaClass<boolean, boolean, never>>;
+    edgeReplication: Schema.optional<typeof Schema.Boolean>;
+    invocationTraceQueue: Schema.optional<Ref.RefSchema<Queue<import("@dxos/echo/Entity").Unknown>>>;
+    name: Schema.optional<typeof Schema.String>;
+    icon: Schema.optional<typeof Schema.String>;
+    hue: Schema.optional<typeof Schema.String>;
+}, readonly [{
+    readonly key: typeof Schema.String;
+    readonly value: typeof Schema.Any;
+}]>;
+export type SpacePropertiesSchema = Schema.Schema.Type<typeof SpacePropertiesSchema>;
+export declare const SpaceProperties: Type.Obj<{
+    readonly [x: string]: any;
+    readonly archived?: boolean | undefined;
+    readonly edgeReplication?: boolean | undefined;
+    readonly invocationTraceQueue?: import("@dxos/echo/internal").Ref<Queue<import("@dxos/echo/Entity").Unknown>> | undefined;
+    readonly name?: string | undefined;
+    readonly icon?: string | undefined;
+    readonly hue?: string | undefined;
+}, Schema.Struct.Fields>;
+export interface SpaceProperties extends Schema.Schema.Type<typeof SpaceProperties> {
+}
+//# sourceMappingURL=SpaceProperties.d.ts.map

package/dist/types/src/types/SpaceProperties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpaceProperties.d.ts","sourceRoot":"","sources":["../../../../src/types/SpaceProperties.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAc,GAAG,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAEtC,eAAO,MAAM,qBAAqB;;;;;;;;;;GAwBjC,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAIrF,eAAO,MAAM,eAAe;;;;;;;;wBAO3B,CAAC;AAEF,MAAM,WAAW,eAAgB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,eAAe,CAAC;CAAG"}

package/dist/types/src/types/index.d.ts

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

package/dist/types/src/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/types/index.ts"],"names":[],"mappings":"AAIA,cAAc,mBAAmB,CAAC"}