@dxos/plugin-space 0.8.4-main.d05673bc65 → 0.8.4-main.d9fc60f731

package/src/operations/definitions.ts

@@ -0,0 +1,523 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Capability, Plugin } from '@dxos/app-framework';
+import { SpaceSchema } from '@dxos/client/echo';
+import { CancellableInvitationObservable, Invitation } from '@dxos/client/invitations';
+import { Operation } from '@dxos/compute';
+import { Collection, Database, Entity, Obj, QueryAST, Type, View, DXN } from '@dxos/echo';
+import { SpaceArchive } from '@dxos/protocols/proto/dxos/client/services';
+
+import { meta } from '#meta';
+
+import { SpaceForm } from '../types';
+
+const COLLECTION_OPERATION = 'org.dxos.plugin.collection.operation';
+
+export namespace CollectionOperation {
+  export const Create = Operation.make({
+    meta: { key: DXN.make(`${COLLECTION_OPERATION}.create`), name: 'Create Collection', icon: 'ph--folder--regular' },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      name: Schema.optional(Schema.String),
+    }),
+    output: Schema.Struct({
+      object: Type.getSchema(Collection.Collection),
+    }),
+  });
+}
+
+const makeKey = (name: string) => DXN.make(`${meta.id}.operation.${name}`);
+
+/**
+ * Operations for the Space plugin.
+ */
+export namespace SpaceOperation {
+  export const Create = Operation.make({
+    meta: {
+      key: makeKey('create'),
+      name: 'Create Space',
+      description: 'Create a new space.',
+      icon: 'ph--plus--regular',
+    },
+    services: [Capability.Service, Plugin.Service],
+    input: SpaceForm,
+    output: Schema.Struct({
+      id: Schema.String,
+      subject: Schema.Array(Schema.String),
+      space: SpaceSchema,
+    }),
+  });
+
+  export const Join = Operation.make({
+    meta: {
+      key: makeKey('join'),
+      name: 'Join Space',
+      description: 'Join a space via invitation.',
+      icon: 'ph--sign-in--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      invitationCode: Schema.optional(Schema.String),
+      onDone: Schema.optional(Schema.Any),
+    }),
+    output: Schema.Void,
+  });
+
+  export const Open = Operation.make({
+    meta: {
+      key: makeKey('open'),
+      name: 'Open Space',
+      description: 'Open a space.',
+      icon: 'ph--arrow-square-out--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      space: SpaceSchema,
+    }),
+    output: Schema.Void,
+  });
+
+  export const Close = Operation.make({
+    meta: {
+      key: makeKey('close'),
+      name: 'Close Space',
+      description: 'Close a space.',
+      icon: 'ph--x-circle--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      space: SpaceSchema,
+    }),
+    output: Schema.Void,
+  });
+
+  export const Delete = Operation.make({
+    meta: {
+      key: makeKey('delete'),
+      name: 'Delete Space',
+      description: 'Delete a space. The deletion replicates to all of your devices.',
+      icon: 'ph--trash--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      space: SpaceSchema,
+    }),
+    output: Schema.Void,
+  });
+
+  export const Share = Operation.make({
+    meta: {
+      key: makeKey('share'),
+      name: 'Share Space',
+      description: 'Share a space.',
+      icon: 'ph--share-network--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      space: SpaceSchema,
+      type: Schema.Enums(Invitation.Type),
+      authMethod: Schema.Enums(Invitation.AuthMethod),
+      multiUse: Schema.Boolean,
+      target: Schema.optional(Schema.String),
+    }),
+    output: Schema.instanceOf(CancellableInvitationObservable),
+  });
+
+  export const OpenSettings = Operation.make({
+    meta: {
+      key: makeKey('openSettings'),
+      name: 'Open Space Settings',
+      description: 'Open space settings.',
+      icon: 'ph--gear--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      space: SpaceSchema,
+    }),
+    output: Schema.Void,
+  });
+
+  export const WaitForObject = Operation.make({
+    meta: {
+      key: makeKey('waitForObject'),
+      name: 'Wait For Object',
+      description: 'Wait for an object to be available.',
+      icon: 'ph--clock-countdown--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      id: Schema.optional(Schema.String),
+    }),
+    output: Schema.Void,
+  });
+
+  export const AddObject = Operation.make({
+    meta: {
+      key: makeKey('addObject'),
+      name: 'Add Object',
+      description: 'Add an object to a space.',
+      icon: 'ph--plus--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      object: Obj.Unknown.annotations({ description: 'The object to add.' }),
+      target: Schema.Union(Database.Database, Type.getSchema(Collection.Collection)).annotations({
+        description: 'The database or collection to add to.',
+      }),
+      hidden: Schema.optional(Schema.Boolean),
+      targetNodeId: Schema.optional(
+        Schema.String.annotations({ description: 'Qualified graph node ID of the target collection.' }),
+      ),
+    }),
+    output: Schema.Struct({
+      id: Schema.String,
+      subject: Schema.Array(Schema.String),
+      object: Obj.Unknown,
+    }),
+  });
+
+  // TODO(wittjosiah): Rename `objects` to `entities` (covers objects, relations, and persisted types).
+  export const RemoveObjectsOutput = Schema.Struct({
+    objects: Schema.Array(Entity.Unknown).annotations({ description: 'The removed entities.' }),
+    parentCollection: Type.getSchema(Collection.Collection).annotations({
+      description: 'The collection removed from.',
+    }),
+    indices: Schema.Array(Schema.Number).annotations({ description: 'The indices the objects were at.' }),
+    wasActive: Schema.Array(Schema.String).annotations({
+      description: 'IDs of objects that were active before removal.',
+    }),
+  });
+
+  export type RemoveObjectsOutput = Schema.Schema.Type<typeof RemoveObjectsOutput>;
+
+  export const RemoveObjects = Operation.make({
+    meta: {
+      key: makeKey('removeObjects'),
+      name: 'Remove Objects',
+      description: 'Remove entities (objects, relations, or persisted types) from a space.',
+      icon: 'ph--trash--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      objects: Schema.Array(Entity.Unknown).annotations({ description: 'The entities to remove.' }),
+      target: Schema.optional(Type.getSchema(Collection.Collection)).annotations({
+        description: 'The collection to remove from.',
+      }),
+    }),
+    output: RemoveObjectsOutput,
+  });
+
+  export const DeleteFieldOutput = Schema.Struct({
+    field: View.FieldSchema.annotations({ description: 'The deleted field schema.' }),
+    // TODO(wittjosiah): This creates a type error with PropertySchema.
+    props: Schema.Any.annotations({ description: 'The deleted field properties.' }),
+    index: Schema.Number.annotations({ description: 'The index the field was at.' }),
+  });
+
+  export type DeleteFieldOutput = Schema.Schema.Type<typeof DeleteFieldOutput>;
+
+  export const DeleteField = Operation.make({
+    meta: {
+      key: makeKey('deleteField'),
+      name: 'Delete Field',
+      description: 'Delete a field from a view.',
+      icon: 'ph--minus-circle--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      view: Type.getSchema(View.View).annotations({ description: 'The view to delete the field from.' }),
+      fieldId: Schema.String,
+    }),
+    output: DeleteFieldOutput,
+  });
+
+  export const OpenCreateObject = Operation.make({
+    meta: {
+      key: makeKey('openCreateObject'),
+      name: 'Open Create Object Dialog',
+      description: 'Open the create object dialog.',
+      icon: 'ph--plus--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      target: Schema.Union(Database.Database, Type.getSchema(Collection.Collection)).annotations({
+        description: 'The database or collection to create in.',
+      }),
+      views: Schema.optional(Schema.Boolean),
+      typename: Schema.optional(Schema.String),
+      initialFormValues: Schema.optional(Schema.Any),
+      navigable: Schema.optional(Schema.Boolean),
+      targetNodeId: Schema.optional(
+        Schema.String.annotations({ description: 'Qualified graph node ID of the target collection.' }),
+      ),
+      // TODO(wittjosiah): This is a function, is there a better way to handle this?
+      onCreateObject: Schema.optional(Schema.Any),
+    }),
+    output: Schema.Void,
+  });
+
+  export const OpenCreateSpace = Operation.make({
+    meta: {
+      key: makeKey('openCreateSpace'),
+      name: 'Open Create Space Dialog',
+      description: 'Open the create space dialog.',
+      icon: 'ph--plus--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Void,
+    output: Schema.Void,
+  });
+
+  export const OpenImportSpace = Operation.make({
+    meta: {
+      key: makeKey('openImportSpace'),
+      name: 'Open Import Space Dialog',
+      description: 'Open the import space dialog to create a new space from a backup.',
+      icon: 'ph--download--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Void,
+    output: Schema.Void,
+  });
+
+  export const ImportSpace = Operation.make({
+    meta: {
+      key: makeKey('importSpace'),
+      name: 'Import Space',
+      description: 'Import a space archive as a new space.',
+      icon: 'ph--upload--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      archive: Schema.Struct({
+        filename: Schema.String,
+        contents: Schema.instanceOf(Uint8Array),
+      }),
+      tags: Schema.Array(Schema.String).pipe(Schema.optional),
+    }),
+    output: Schema.Struct({
+      space: SpaceSchema,
+    }),
+  });
+
+  export const ExportSpace = Operation.make({
+    meta: {
+      key: makeKey('exportSpace'),
+      name: 'Export Space',
+      description: 'Export a space as a backup and download the archive.',
+      icon: 'ph--download--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      space: SpaceSchema,
+      format: Schema.Enums(SpaceArchive.Format),
+    }),
+    output: Schema.Void,
+  });
+
+  export const Migrate = Operation.make({
+    meta: {
+      key: makeKey('migrate'),
+      name: 'Migrate Space',
+      description: 'Migrate a space to a new version.',
+      icon: 'ph--arrows-clockwise--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      space: SpaceSchema,
+      version: Schema.optional(Schema.String),
+    }),
+    output: Schema.Boolean,
+  });
+
+  export const Snapshot = Operation.make({
+    meta: {
+      key: makeKey('snapshot'),
+      name: 'Create Snapshot',
+      description: 'Create a snapshot of the space.',
+      icon: 'ph--camera--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      db: Database.Database,
+      query: QueryAST.Query.pipe(Schema.optional),
+    }),
+    output: Schema.Struct({
+      snapshot: Schema.instanceOf(Blob),
+    }),
+  });
+
+  export const Rename = Operation.make({
+    meta: {
+      key: makeKey('rename'),
+      name: 'Rename Space',
+      description: 'Rename a space.',
+      icon: 'ph--pencil-simple--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      space: SpaceSchema,
+      caller: Schema.optional(Schema.String),
+    }),
+    output: Schema.Void,
+  });
+
+  export const RenameObject = Operation.make({
+    meta: {
+      key: makeKey('renameObject'),
+      name: 'Rename Object',
+      description: 'Rename an entity (object, relation, or persisted type).',
+      icon: 'ph--pencil-simple--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      object: Entity.Unknown,
+      caller: Schema.optional(Schema.String),
+    }),
+    output: Schema.Void,
+  });
+
+  export const OpenMembers = Operation.make({
+    meta: {
+      key: makeKey('openMembers'),
+      name: 'Open Members',
+      description: 'Open the members panel for a space.',
+      icon: 'ph--users--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      space: SpaceSchema,
+    }),
+    output: Schema.Void,
+  });
+
+  export const GetShareLink = Operation.make({
+    meta: {
+      key: makeKey('getShareLink'),
+      name: 'Get Share Link',
+      description: 'Get a shareable link for a space.',
+      icon: 'ph--link--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      space: SpaceSchema,
+      target: Schema.optional(Schema.String),
+      copyToClipboard: Schema.optional(Schema.Boolean),
+    }),
+    output: Schema.String,
+  });
+
+  export const StoredSchemaForm = Schema.Struct({
+    name: Schema.optional(Schema.String),
+  });
+
+  export const AddType = Operation.make({
+    meta: {
+      key: makeKey('addType'),
+      name: 'Add Type',
+      description: 'Add a type to the space.',
+      icon: 'ph--code--regular',
+    },
+    services: [Capability.Service, Plugin.Service],
+    input: Schema.Struct({
+      db: Database.Database,
+      name: Schema.optional(Schema.String),
+      typename: Schema.optional(Schema.String),
+      version: Schema.optional(Schema.String),
+      // TODO(wittjosiah): Schema for type?
+      type: Schema.Any,
+      show: Schema.optional(Schema.Boolean),
+    }),
+    output: Schema.Struct({
+      id: Schema.String,
+      object: Type.getSchema(Type.Type),
+    }),
+  });
+
+  export const AddRelation = Operation.make({
+    meta: {
+      key: makeKey('addRelation'),
+      name: 'Add Relation',
+      description: 'Add a relation between objects.',
+      icon: 'ph--link--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      db: Database.Database,
+      // TODO(wittjosiah): Relation schema.
+      schema: Schema.Any,
+      source: Obj.Unknown,
+      target: Obj.Unknown,
+      // TODO(wittjosiah): Type based on relation schema.
+      fields: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Any })),
+    }),
+    output: Schema.Struct({
+      relation: Schema.Any,
+    }),
+  });
+
+  // TODO(wittjosiah): This appears to be unused.
+  export const DuplicateObject = Operation.make({
+    meta: {
+      key: makeKey('duplicateObject'),
+      name: 'Duplicate Object',
+      description: 'Duplicate an object.',
+      icon: 'ph--file--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      object: Obj.Unknown,
+      target: Schema.Union(Database.Database, Type.getSchema(Collection.Collection)),
+    }),
+    output: Schema.Void,
+  });
+
+  /**
+   * Restore a deleted field to a view (inverse of DeleteField).
+   */
+  export const RestoreField = Operation.make({
+    meta: {
+      key: makeKey('restoreField'),
+      name: 'Restore Field',
+      description: 'Restore a deleted field to a view.',
+      icon: 'ph--clock-counter-clockwise--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      view: Type.getSchema(View.View).annotations({ description: 'The view to restore the field to.' }),
+      field: View.FieldSchema.annotations({ description: 'The field schema to restore.' }),
+      // TODO(wittjosiah): This creates a type error with PropertySchema.
+      props: Schema.Any.annotations({ description: 'The field properties to restore.' }),
+      index: Schema.Number.annotations({ description: 'The index to restore the field at.' }),
+    }),
+    output: Schema.Void,
+  });
+
+  /**
+   * Restore deleted entities to a space (inverse of RemoveObjects).
+   */
+  export const RestoreObjects = Operation.make({
+    meta: {
+      key: makeKey('restoreObjects'),
+      name: 'Restore Objects',
+      description: 'Restore deleted entities to a space.',
+      icon: 'ph--clock-counter-clockwise--regular',
+    },
+    services: [Capability.Service],
+    input: Schema.Struct({
+      objects: Schema.Array(Entity.Unknown).annotations({ description: 'The entities to restore.' }),
+      parentCollection: Type.getSchema(Collection.Collection).annotations({
+        description: 'The collection to restore to.',
+      }),
+      indices: Schema.Array(Schema.Number).annotations({ description: 'The indices to restore at.' }),
+      wasActive: Schema.Array(Schema.String).annotations({
+        description: 'IDs of objects that were active before deletion.',
+      }),
+    }),
+    output: Schema.Void,
+  });
+}

package/src/operations/delete-field.ts

@@ -0,0 +1,43 @@
+// Copyright 2025 DXOS.org
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/compute';
+import { Filter, JsonSchema, Obj, Type } from '@dxos/echo';
+import { invariant } from '@dxos/invariant';
+import { ProjectionModel, createEchoChangeCallback, getTypenameFromQuery } from '@dxos/schema';
+
+import { SpaceOperation } from './definitions';
+
+const handler: Operation.WithHandler<typeof SpaceOperation.DeleteField> = SpaceOperation.DeleteField.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* (input) {
+      const registry = yield* Capability.get(Capabilities.AtomRegistry);
+      const view = input.view as any;
+      const db = Obj.getDatabase(view);
+      invariant(db);
+      const typename = getTypenameFromQuery(view.query.ast);
+      invariant(typename);
+      const types = yield* Effect.promise(() => db.query(Filter.type(Type.Type)).run());
+      const schema = types.find((t) => Type.getTypename(t) === typename);
+      invariant(schema);
+
+      const projection = new ProjectionModel({
+        registry,
+        view,
+        baseSchema: JsonSchema.toJsonSchema(schema),
+        change: createEchoChangeCallback(view, schema),
+      });
+
+      const result = projection.deleteFieldProjection(input.fieldId);
+
+      return {
+        field: result.deleted.field,
+        props: result.deleted.props,
+        index: result.index,
+      };
+    }),
+  ),
+);
+export default handler;

package/src/operations/delete.ts

@@ -0,0 +1,18 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/compute';
+
+import { SpaceOperation } from './definitions';
+
+const handler: Operation.WithHandler<typeof SpaceOperation.Delete> = SpaceOperation.Delete.pipe(
+  Operation.withHandler((input) =>
+    Effect.promise(async () => {
+      await input.space.delete();
+    }),
+  ),
+);
+export default handler;

package/src/operations/duplicate-object.ts

@@ -0,0 +1,17 @@
+// Copyright 2025 DXOS.org
+
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/compute';
+
+import { SpaceOperation } from './definitions';
+
+// TODO(wittjosiah): Implement object duplication without serializer.
+const handler: Operation.WithHandler<typeof SpaceOperation.DuplicateObject> = SpaceOperation.DuplicateObject.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* () {
+      yield* Effect.fail(new Error('DuplicateObject is not yet implemented.'));
+    }),
+  ),
+);
+export default handler;

package/src/operations/export-space.ts

@@ -0,0 +1,30 @@
+// Copyright 2026 DXOS.org
+
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/compute';
+
+import { SpaceOperation } from './definitions';
+
+const handler: Operation.WithHandler<typeof SpaceOperation.ExportSpace> = SpaceOperation.ExportSpace.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ space, format }) {
+      yield* Effect.promise(() => space.waitUntilReady());
+      const archive = yield* Effect.promise(() => space.internal.export({ format }));
+      yield* Effect.sync(() => {
+        downloadArchive(new Blob([archive.contents as Uint8Array<ArrayBuffer>]), archive.filename);
+      });
+    }),
+  ),
+);
+export default handler;
+
+const downloadArchive = (data: Blob, filename: string): void => {
+  const url = URL.createObjectURL(data);
+  const element = document.createElement('a');
+  element.setAttribute('href', url);
+  element.setAttribute('download', filename);
+  element.setAttribute('target', 'download');
+  element.click();
+  URL.revokeObjectURL(url);
+};

package/src/operations/get-share-link.ts

@@ -0,0 +1,43 @@
+// Copyright 2025 DXOS.org
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/compute';
+
+import { SpaceOperation } from './definitions';
+import { SpaceOperationConfig } from './helpers';
+
+const handler: Operation.WithHandler<typeof SpaceOperation.GetShareLink> = SpaceOperation.GetShareLink.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* (input) {
+      const { Invitation, InvitationEncoder } = yield* Effect.promise(() => import('@dxos/react-client/invitations'));
+
+      const invitation = yield* Operation.invoke(SpaceOperation.Share, {
+        space: input.space,
+        type: Invitation.Type.DELEGATED,
+        authMethod: Invitation.AuthMethod.KNOWN_PUBLIC_KEY,
+        multiUse: true,
+        target: input.target,
+      });
+
+      const invitationCode = yield* Effect.tryPromise(
+        () =>
+          new Promise<string>((resolve) => {
+            invitation.subscribe((inv) => {
+              if (inv.state === Invitation.State.CONNECTING) {
+                resolve(InvitationEncoder.encode(inv));
+              }
+            });
+          }),
+      );
+      const { createInvitationUrl } = yield* Capability.get(SpaceOperationConfig);
+      const url = createInvitationUrl(invitationCode);
+      if (input.copyToClipboard) {
+        yield* Effect.tryPromise(() => navigator.clipboard.writeText(url));
+      }
+      return url;
+    }),
+  ),
+);
+export default handler;

package/src/operations/helpers.ts

@@ -0,0 +1,10 @@
+// Copyright 2025 DXOS.org
+
+import { Capability } from '@dxos/app-framework';
+
+export type SpaceOperationConfig = {
+  createInvitationUrl: (invitationCode: string) => string;
+  observability: boolean;
+};
+
+export const SpaceOperationConfig = Capability.make<SpaceOperationConfig>('org.dxos.plugin.space.operation-config');