@dxos/client-protocol 0.8.4-main.fffef41 → 0.8.4-staging.60fe92afc8

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

@@ -1,25 +1,35 @@
 import * as Schema from 'effect/Schema';
-import { type CleanupFn, type MulticastObservable } from '@dxos/async';
+import { type MulticastObservable } from '@dxos/async';
 import { type SpecificCredential } from '@dxos/credentials';
-import { type AnyLiveObject, type EchoDatabase, type QueueFactory, type SpaceSyncState } from '@dxos/echo-db';
+import { type Database, type Obj } from '@dxos/echo';
+import { type EchoDatabase, type QueueFactory, type SpaceSyncState } from '@dxos/echo-client';
 import { type PublicKey, type SpaceId } from '@dxos/keys';
-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 Messenger } from '@dxos/protocols';
+import { type Contact, type CreateEpochRequest, type Invitation, 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 Credential, type Epoch, type MembershipPolicy } from '@dxos/protocols/proto/dxos/halo/credentials';
 import { type CancellableInvitation } from './invitations';
+import { type SpaceProperties } from './types';
 export type CreateEpochOptions = {
     migration?: CreateEpochRequest.Migration;
     automergeRootUrl?: string;
 };
+export type ExportSpaceOptions = {
+    /**
+     * Archive format.
+     * @default SpaceArchive.Format.BINARY
+     */
+    format?: SpaceArchive.Format;
+};
 export interface SpaceInternal {
+    get db(): EchoDatabase;
     get data(): SpaceData;
     getCredentials(): Promise<Credential[]>;
     getEpochs(): Promise<SpecificCredential<Epoch>[]>;
     createEpoch(options?: CreateEpochOptions): Promise<void>;
     removeMember(memberKey: PublicKey): Promise<void>;
-    export(): Promise<SpaceArchive>;
+    export(options?: ExportSpaceOptions): Promise<SpaceArchive>;
     /**
      * Migrate space data to the latest version.
      */
@@ -35,7 +45,7 @@ export interface SpaceInternal {
     }): Promise<void>;
 }
 export declare const SPACE_TAG: unique symbol;
-export interface Space {
+export interface Space extends Messenger {
     readonly [SPACE_TAG]: true;
     /**
      * @deprecated Use `id`.
@@ -48,12 +58,22 @@ export interface Space {
     /**
      * Echo database.
      */
-    get db(): EchoDatabase;
+    get db(): Database.Database;
     /**
      * Access to queues.
      */
     get queues(): QueueFactory;
     get isOpen(): boolean;
+    /**
+     * Immutable tags assigned at space creation time.
+     * Available on closed spaces.
+     */
+    get tags(): string[];
+    /**
+     * Immutable membership policy assigned at space creation time.
+     * Available on closed spaces.
+     */
+    get membershipPolicy(): MembershipPolicy;
     /**
      * Current state of the space.
      * The database is ready to be used in `SpaceState.SPACE_READY` state.
@@ -63,7 +83,7 @@ export interface Space {
     /**
      * Properties object.
      */
-    get properties(): AnyLiveObject<any>;
+    get properties(): Obj.OfShape<SpaceProperties>;
     /**
      * Current state of space pipeline.
      */
@@ -85,6 +105,12 @@ export interface Space {
      * The setting is persisted on the local device.
      */
     close(): Promise<void>;
+    /**
+     * Tombstones (soft-deletes) the space and replicates the deletion to the user's other devices.
+     * Every device stops replicating and unloads the space. Underlying data is not removed until
+     * garbage collection (future work). This is terminal: the space cannot be re-opened via {@link open}.
+     */
+    delete(): Promise<void>;
     /**
      * Waits until the space is in the ready state, with database initialized.
      */
@@ -93,8 +119,6 @@ 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>;

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,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,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,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAC9G,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;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,KAAK;IACpB,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,YAAY,CAAC;IAEvB;;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,aAAa,CAAC,GAAG,CAAC,CAAC;IAErC;;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;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;AAED,eAAO,MAAM,OAAO,GAAI,QAAQ,OAAO,KAAG,MAAM,IAAI,KACmC,CAAC;AAGxF,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAG5C,CAAC"}
+{"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,mBAAmB,CAAC;AAC9F,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,YAAY,EACZ,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,KAAK,gBAAgB,EAAE,MAAM,6CAA6C,CAAC;AAEjH,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,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC;CAC9B,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,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE5D;;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;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;IAErB;;;OAGG;IACH,IAAI,gBAAgB,IAAI,gBAAgB,CAAC;IAEzC;;;;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;;;;OAIG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB;;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,WAAY,OAAO,KAAG,MAAM,IAAI,KACmC,CAAC;AAGxF,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAG5C,CAAC"}

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

@@ -0,0 +1,47 @@
+import * as Schema from 'effect/Schema';
+import { Ref, Type } from '@dxos/echo';
+/**
+ * Where do triggers get executed.
+ */
+export declare const ComputeEnvironment: Schema.Literal<["disabled", "local", "edge"]>;
+export type ComputeEnvironment = Schema.Schema.Type<typeof ComputeEnvironment>;
+export declare const SpacePropertiesSchema: Schema.Struct<{
+    edgeReplication: Schema.optional<typeof Schema.Boolean>;
+    /**
+     * @deprecated
+     */
+    invocationTraceFeed: Schema.optional<Ref.RefSchema<{
+        readonly name?: string | undefined;
+        readonly kind?: string | undefined;
+        readonly namespace?: "data" | "trace" | undefined;
+    } & import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & import("@dxos/echo/Obj").Unknown>>;
+    /**
+     * Preference for trigger execution.
+     * *disabled* - triggers do not run locally or on EDGE.
+     * *local* - triggers are executed locally on the client, edge is not running triggers.
+     * *edge* - triggers are executed on the edge, triggers are not run locally.
+     */
+    computeEnvironment: Schema.optional<Schema.Literal<["disabled", "local", "edge"]>>;
+    name: Schema.optional<typeof Schema.String>;
+    description: Schema.optional<typeof Schema.String>;
+    icon: Schema.optional<typeof Schema.String>;
+    iconHue: Schema.optional<typeof Schema.String>;
+    hue: Schema.optional<typeof Schema.String>;
+}>;
+export type SpacePropertiesSchema = Schema.Schema.Type<typeof SpacePropertiesSchema>;
+export declare const SpaceProperties: Type.Obj<{
+    readonly edgeReplication?: boolean | undefined;
+    readonly invocationTraceFeed?: import("@dxos/echo/internal").Ref<{
+        readonly name?: string | undefined;
+        readonly kind?: string | undefined;
+        readonly namespace?: "data" | "trace" | undefined;
+    } & import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & import("@dxos/echo/Obj").Unknown> | undefined;
+    readonly computeEnvironment?: "disabled" | "edge" | "local" | undefined;
+    readonly name?: string | undefined;
+    readonly description?: string | undefined;
+    readonly icon?: string | undefined;
+    readonly iconHue?: string | undefined;
+    readonly hue?: string | undefined;
+}, Schema.Struct.Fields>;
+export type SpaceProperties = Type.InstanceType<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,EAAyB,GAAG,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,kBAAkB,+CAA8C,CAAC;AAC9E,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE/E,eAAO,MAAM,qBAAqB;;IAShC;;OAEG;;;;;;IAGH;;;;;OAKG;;;;;;;EAYH,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAIrF,eAAO,MAAM,eAAe;;;;;;;;;;;;;wBAG3B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,eAAe,CAAC,CAAC"}

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

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

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

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