@dxos/plugin-space 0.8.4-main.5ea62a8 → 0.8.4-main.66e292d

package/src/types/types.ts

@@ -2,21 +2,23 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
 import { type AnyIntentChain } from '@dxos/app-framework';
-import { type Obj, Type } from '@dxos/echo';
-import { type BaseObject, EchoSchema, StoredSchema, type TypedObject } from '@dxos/echo-schema';
+import { type Obj, QueryAST, Type } from '@dxos/echo';
 import { type PublicKey } from '@dxos/react-client';
 // TODO(wittjosiah): This pulls in full client.
 import { EchoObjectSchema, ReactiveObjectSchema, type Space, SpaceSchema } from '@dxos/react-client/echo';
 import { CancellableInvitationObservable, Invitation } from '@dxos/react-client/invitations';
-import { DataType, FieldSchema, TypenameAnnotationId } from '@dxos/schema';
+import { Collection, FieldSchema, View } from '@dxos/schema';
 import { type ComplexMap } from '@dxos/util';
 
-import { SPACE_PLUGIN } from '../meta';
+import { meta } from '../meta';
+
+import { TypeInputOptionsAnnotation } from './form';
+
+export const SPACE_DIRECTORY_HANDLE = `${meta.id}/directory`;
 
-export const SPACE_DIRECTORY_HANDLE = 'dxos.org/plugin/space/directory';
 export const SPACE_TYPE = 'dxos.org/type/Space';
 
 export type ObjectViewerProps = {
@@ -81,7 +83,7 @@ export type SpaceSettingsProps = Schema.Schema.Type<typeof SpaceSettingsSchema>;
 
 export type SerializerMap = Record<string, TypedObjectSerializer>;
 
-export interface TypedObjectSerializer<T extends Obj.Any = Type.Expando> {
+export interface TypedObjectSerializer<T extends Obj.Any = Obj.Any> {
   serialize(params: { object: T }): Promise<string>;
 
   /**
@@ -92,6 +94,8 @@ export interface TypedObjectSerializer<T extends Obj.Any = Type.Expando> {
   deserialize(params: { content: string; space: Space; newId?: boolean }): Promise<T>;
 }
 
+export type CreateObjectIntent = (props: any, options: { space: Space }) => AnyIntentChain;
+
 // TODO(burdon): Move to FormatEnum or SDK.
 export const IconAnnotationId = Symbol.for('@dxos/plugin-space/annotation/Icon');
 export const HueAnnotationId = Symbol.for('@dxos/plugin-space/annotation/Hue');
@@ -104,17 +108,7 @@ export const SpaceForm = Schema.Struct({
   edgeReplication: Schema.Boolean.annotations({ title: 'Enable EDGE Replication' }),
 });
 
-export type ObjectForm<T extends BaseObject = BaseObject> = {
-  // TODO(dmaretskyi): Change to Schema.Schema.AnyNoContext
-  objectSchema: TypedObject;
-  formSchema?: Schema.Schema<T, any>;
-  hidden?: boolean;
-  getIntent: (props: T, options: { space: Space }) => AnyIntentChain;
-};
-
-export const defineObjectForm = <T extends BaseObject>(form: ObjectForm<T>) => form;
-
-export const SPACE_ACTION = `${SPACE_PLUGIN}/action`;
+export const SPACE_ACTION = `${meta.id}/action`;
 
 export namespace SpaceAction {
   export class OpenCreateSpace extends Schema.TaggedClass<OpenCreateSpace>()(`${SPACE_ACTION}/open-create-space`, {
@@ -217,12 +211,26 @@ export namespace SpaceAction {
     output: Schema.Boolean,
   }) {}
 
+  export class Snapshot extends Schema.TaggedClass<Snapshot>()(`${SPACE_ACTION}/snapshot`, {
+    input: Schema.Struct({
+      space: SpaceSchema,
+      query: QueryAST.Query.pipe(Schema.optional),
+    }),
+    output: Schema.Struct({
+      snapshot: Schema.instanceOf(Blob),
+    }),
+  }) {}
+
   export const StoredSchemaForm = Schema.Struct({
     name: Schema.optional(Schema.String),
-    typename: Schema.optional(
-      Schema.String.annotations({
-        [TypenameAnnotationId]: ['unused-static'],
+    typename: Schema.String.pipe(
+      Schema.annotations({ title: 'Select type (leave blank to create a new type)' }),
+      TypeInputOptionsAnnotation.set({
+        location: ['runtime'],
+        kind: ['user'],
+        registered: ['unregistered'],
       }),
+      Schema.optional,
     ),
   });
 
@@ -230,6 +238,8 @@ export namespace SpaceAction {
     input: Schema.Struct({
       space: SpaceSchema,
       typename: Schema.String,
+      // TODO(wittjosiah): This is leaky.
+      show: Schema.optional(Schema.Boolean),
     }),
     output: Schema.Struct({}),
   }) {}
@@ -243,18 +253,20 @@ export namespace SpaceAction {
       version: Schema.optional(Schema.String),
       // TODO(wittjosiah): Schema for schema?
       schema: Schema.Any,
+      // TODO(wittjosiah): This is leaky.
+      show: Schema.optional(Schema.Boolean),
     }),
     output: Schema.Struct({
       // TODO(wittjosiah): ObjectId.
       id: Schema.String,
-      object: StoredSchema,
-      schema: Schema.instanceOf(EchoSchema),
+      object: Type.PersistentType,
+      schema: Schema.instanceOf(Type.RuntimeType),
     }),
   }) {}
 
   export class DeleteField extends Schema.TaggedClass<DeleteField>()(`${SPACE_ACTION}/delete-field`, {
     input: Schema.Struct({
-      view: DataType.View,
+      view: View.View,
       fieldId: Schema.String,
       // TODO(wittjosiah): Separate fields for undo data?
       deletionData: Schema.optional(
@@ -272,7 +284,7 @@ export namespace SpaceAction {
 
   export class OpenCreateObject extends Schema.TaggedClass<OpenCreateObject>()(`${SPACE_ACTION}/open-create-object`, {
     input: Schema.Struct({
-      target: Schema.Union(SpaceSchema, DataType.Collection),
+      target: Schema.Union(SpaceSchema, Collection.Collection),
       views: Schema.optional(Schema.Boolean),
       typename: Schema.optional(Schema.String),
       initialFormValues: Schema.optional(Schema.Any),
@@ -286,7 +298,7 @@ export namespace SpaceAction {
   export class AddObject extends Schema.TaggedClass<AddObject>()(`${SPACE_ACTION}/add-object`, {
     input: Schema.Struct({
       object: ReactiveObjectSchema,
-      target: Schema.Union(SpaceSchema, DataType.Collection),
+      target: Schema.Union(SpaceSchema, Collection.Collection),
       hidden: Schema.optional(Schema.Boolean),
     }),
     output: Schema.Struct({
@@ -314,7 +326,7 @@ export namespace SpaceAction {
 
   export const DeletionData = Schema.Struct({
     objects: Schema.Array(EchoObjectSchema),
-    parentCollection: DataType.Collection,
+    parentCollection: Collection.Collection,
     indices: Schema.Array(Schema.Number),
     nestedObjectsList: Schema.Array(Schema.Array(EchoObjectSchema)),
     wasActive: Schema.Array(Schema.String),
@@ -324,8 +336,9 @@ export namespace SpaceAction {
 
   export class RemoveObjects extends Schema.TaggedClass<RemoveObjects>()(`${SPACE_ACTION}/remove-objects`, {
     input: Schema.Struct({
-      objects: Schema.Array(EchoObjectSchema),
-      target: Schema.optional(DataType.Collection),
+      // TODO(wittjosiah): Should be Schema.Union(Type.Obj, Type.Relation).
+      objects: Schema.Array(ReactiveObjectSchema),
+      target: Schema.optional(Collection.Collection),
       deletionData: Schema.optional(DeletionData),
     }),
     output: Schema.Void,
@@ -342,7 +355,7 @@ export namespace SpaceAction {
   export class DuplicateObject extends Schema.TaggedClass<DuplicateObject>()(`${SPACE_ACTION}/duplicate-object`, {
     input: Schema.Struct({
       object: EchoObjectSchema,
-      target: Schema.Union(SpaceSchema, DataType.Collection),
+      target: Schema.Union(SpaceSchema, Collection.Collection),
     }),
     output: Schema.Void,
   }) {}
@@ -361,26 +374,7 @@ export namespace CollectionAction {
       name: Schema.optional(Schema.String),
     }),
     output: Schema.Struct({
-      object: DataType.Collection,
+      object: Collection.Collection,
     }),
   }) {}
-
-  export const QueryCollectionForm = Schema.Struct({
-    name: Schema.optional(Schema.String),
-    typename: Schema.optional(
-      Schema.String.annotations({
-        [TypenameAnnotationId]: ['object-form'],
-      }),
-    ),
-  });
-
-  export class CreateQueryCollection extends Schema.TaggedClass<CreateQueryCollection>()(
-    'dxos.org/plugin/collection/action/create-query-collection',
-    {
-      input: QueryCollectionForm,
-      output: Schema.Struct({
-        object: DataType.QueryCollection,
-      }),
-    },
-  ) {}
 }