@dxos/plugin-space 0.8.3 → 0.8.4-main.1068cf700f

package/src/capabilities/react-surface.tsx

@@ -1,349 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Schema } from 'effect';
-import React, { useCallback, useMemo } from 'react';
-
-import {
-  Capabilities,
-  contributes,
-  createSurface,
-  Surface,
-  useCapabilities,
-  useCapability,
-  useLayout,
-} from '@dxos/app-framework';
-import { Obj, Type } from '@dxos/echo';
-import { findAnnotation } from '@dxos/effect';
-import { SettingsStore } from '@dxos/local-storage';
-import { ClientCapabilities } from '@dxos/plugin-client';
-import { useClient } from '@dxos/react-client';
-import { getSpace, isLiveObject, isSpace, parseId, SpaceState, useSpace, type Space } from '@dxos/react-client/echo';
-import { Input, useTranslation } from '@dxos/react-ui';
-import { type InputProps, SelectInput } from '@dxos/react-ui-form';
-import { HuePicker, IconPicker } from '@dxos/react-ui-pickers';
-import { DataType, type TypenameAnnotation, TypenameAnnotationId } from '@dxos/schema';
-import { type JoinPanelProps } from '@dxos/shell/react';
-
-import { SpaceCapabilities } from './capabilities';
-import {
-  CollectionMain,
-  CollectionSection,
-  CREATE_OBJECT_DIALOG,
-  CREATE_SPACE_DIALOG,
-  CreateObjectDialog,
-  CreateSpaceDialog,
-  InlineSyncStatus,
-  JOIN_DIALOG,
-  JoinDialog,
-  MembersContainer,
-  MenuFooter,
-  ObjectSettingsContainer,
-  POPOVER_RENAME_OBJECT,
-  POPOVER_RENAME_SPACE,
-  PopoverRenameObject,
-  PopoverRenameSpace,
-  SchemaContainer,
-  SmallPresenceLive,
-  SpacePluginSettings,
-  SpacePresence,
-  SpaceSettingsContainer,
-  SyncStatus,
-  type CreateObjectDialogProps,
-} from '../components';
-import { SPACE_PLUGIN } from '../meta';
-import { HueAnnotationId, IconAnnotationId, type SpaceSettingsProps } from '../types';
-
-type ReactSurfaceOptions = {
-  createInvitationUrl: (invitationCode: string) => string;
-};
-
-const OMIT = [Type.getTypename(DataType.Collection), Type.getTypename(DataType.QueryCollection)];
-
-export default ({ createInvitationUrl }: ReactSurfaceOptions) =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      id: `${SPACE_PLUGIN}/article`,
-      role: 'article',
-      filter: (data): data is { subject: Space } =>
-        // TODO(wittjosiah): Need to avoid shotgun parsing space state everywhere.
-        isSpace(data.subject) && data.subject.state.get() === SpaceState.SPACE_READY,
-      component: ({ data, role, ...rest }) => (
-        <Surface
-          data={{
-            id: data.subject.id,
-            subject: data.subject.properties[Type.getTypename(DataType.Collection)]?.target,
-          }}
-          role={role}
-          {...rest}
-        />
-      ),
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/collection-fallback`,
-      role: 'article',
-      position: 'fallback',
-      filter: (data): data is { subject: DataType.Collection } => Obj.instanceOf(DataType.Collection, data.subject),
-      component: ({ data }) => <CollectionMain collection={data.subject} />,
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/plugin-settings`,
-      role: 'article',
-      filter: (data): data is { subject: SettingsStore<SpaceSettingsProps> } =>
-        data.subject instanceof SettingsStore && data.subject.prefix === SPACE_PLUGIN,
-      component: ({ data: { subject } }) => <SpacePluginSettings settings={subject.value} />,
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/companion/object-settings`,
-      role: 'article',
-      filter: (data): data is { companionTo: Obj.Any } => Obj.isObject(data.companionTo) && data.subject === 'settings',
-      component: ({ data, role }) => <ObjectSettingsContainer object={data.companionTo} role={role} />,
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/space-settings-properties`,
-      role: 'article',
-      filter: (data): data is { subject: string } => data.subject === `${SPACE_PLUGIN}/properties`,
-      component: () => {
-        const layout = useLayout();
-        const { spaceId } = parseId(layout.workspace);
-        const space = useSpace(spaceId);
-        if (!space || !spaceId) {
-          return null;
-        }
-
-        return <SpaceSettingsContainer space={space} />;
-      },
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/space-settings-members`,
-      role: 'article',
-      position: 'hoist',
-      filter: (data): data is { subject: string } => data.subject === `${SPACE_PLUGIN}/members`,
-      component: () => {
-        const layout = useLayout();
-        const { spaceId } = parseId(layout.workspace);
-        const space = useSpace(spaceId);
-        if (!space || !spaceId) {
-          return null;
-        }
-
-        return <MembersContainer space={space} createInvitationUrl={createInvitationUrl} />;
-      },
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/space-settings-schema`,
-      role: 'article',
-      filter: (data): data is { subject: string } => data.subject === `${SPACE_PLUGIN}/schema`,
-      component: () => {
-        const layout = useLayout();
-        const { spaceId } = parseId(layout.workspace);
-        const space = useSpace(spaceId);
-        if (!space || !spaceId) {
-          return null;
-        }
-
-        return <SchemaContainer space={space} />;
-      },
-    }),
-    createSurface({
-      id: JOIN_DIALOG,
-      role: 'dialog',
-      filter: (data): data is { props: JoinPanelProps } => data.component === JOIN_DIALOG,
-      component: ({ data }) => <JoinDialog {...data.props} />,
-    }),
-    createSurface({
-      id: CREATE_SPACE_DIALOG,
-      role: 'dialog',
-      filter: (data): data is any => data.component === CREATE_SPACE_DIALOG,
-      component: () => <CreateSpaceDialog />,
-    }),
-    createSurface({
-      id: CREATE_OBJECT_DIALOG,
-      role: 'dialog',
-      filter: (data): data is { props: CreateObjectDialogProps } => data.component === CREATE_OBJECT_DIALOG,
-      component: ({ data }) => <CreateObjectDialog {...data.props} />,
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/create-initial-space-form-[hue]`,
-      role: 'form-input',
-      filter: (data): data is { prop: string; schema: Schema.Schema<any> } => {
-        const annotation = findAnnotation<boolean>((data.schema as Schema.Schema.All).ast, HueAnnotationId);
-        return !!annotation;
-      },
-      component: ({ data: _, ...inputProps }) => {
-        const { label, disabled, type, getValue, onValueChange } = inputProps as any as InputProps;
-        const handleChange = useCallback((nextHue: string) => onValueChange(type, nextHue), [onValueChange]);
-        const handleReset = useCallback(() => onValueChange(type, undefined), [onValueChange]);
-        return (
-          <Input.Root>
-            <Input.Label>{label}</Input.Label>
-            <HuePicker disabled={disabled} value={getValue() ?? ''} onChange={handleChange} onReset={handleReset} />
-          </Input.Root>
-        );
-      },
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/create-initial-space-form-[icon]`,
-      role: 'form-input',
-      filter: (data): data is { prop: string; schema: Schema.Schema<any> } => {
-        const annotation = findAnnotation<boolean>((data.schema as Schema.Schema.All).ast, IconAnnotationId);
-        return !!annotation;
-      },
-      component: ({ data: _, ...inputProps }) => {
-        const { label, disabled, type, getValue, onValueChange } = inputProps as any as InputProps;
-        const handleChange = useCallback((nextIcon: string) => onValueChange(type, nextIcon), [onValueChange]);
-        const handleReset = useCallback(() => onValueChange(type, undefined), [onValueChange]);
-        return (
-          <Input.Root>
-            <Input.Label>{label}</Input.Label>
-            <IconPicker disabled={disabled} value={getValue() ?? ''} onChange={handleChange} onReset={handleReset} />
-          </Input.Root>
-        );
-      },
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/typename-form-input`,
-      role: 'form-input',
-      filter: (
-        data,
-      ): data is { prop: string; schema: Schema.Schema<any>; target: Space | DataType.Collection | undefined } => {
-        if (data.prop !== 'typename') {
-          return false;
-        }
-
-        const annotation = findAnnotation((data.schema as Schema.Schema.All).ast, TypenameAnnotationId);
-        return !!annotation;
-      },
-      component: ({ data: { schema, target }, ...inputProps }) => {
-        const { t } = useTranslation();
-        const client = useClient();
-        const props = inputProps as any as InputProps;
-        const space = isSpace(target) ? target : getSpace(target);
-        if (!space) {
-          return null;
-        }
-
-        const annotation = findAnnotation<TypenameAnnotation[]>(schema.ast, TypenameAnnotationId)!;
-
-        const schemaWhitelists = useCapabilities(ClientCapabilities.SchemaWhiteList);
-        const whitelistedTypenames = useMemo(
-          () => new Set(schemaWhitelists.flatMap((typeArray) => typeArray.map((type) => type.typename))),
-          [schemaWhitelists],
-        );
-
-        const objectForms = useCapabilities(SpaceCapabilities.ObjectForm);
-        const objectFormTypenames = useMemo(
-          () =>
-            new Set(
-              objectForms
-                .map((form) => Type.getTypename(form.objectSchema))
-                // TODO(wittjosiah): Remove.
-                .filter((typename) => !OMIT.includes(typename)),
-            ),
-          [objectForms],
-        );
-
-        const fixed = client.graph.schemaRegistry.schemas.filter((schema) => {
-          const limitedStatic =
-            annotation.includes('limited-static') && whitelistedTypenames.has(Type.getTypename(schema));
-          const objectForm = annotation.includes('object-form') && objectFormTypenames.has(Type.getTypename(schema));
-          return annotation.includes('static') || limitedStatic || objectForm;
-        });
-        const dynamic = space?.db.schemaRegistry.query().runSync();
-        const typenames = Array.from(
-          new Set<string>([
-            ...(annotation.includes('limited-static') ||
-            annotation.includes('static') ||
-            annotation.includes('object-form')
-              ? fixed.map((schema) => Type.getTypename(schema))
-              : []),
-            ...(annotation.includes('dynamic') ? dynamic.map((schema) => schema.typename) : []),
-          ]),
-        ).sort();
-
-        const options = useMemo(
-          () =>
-            typenames.map((typename) => ({
-              value: typename,
-              label: t('typename label', { ns: typename, defaultValue: typename }),
-            })),
-          [t, typenames],
-        );
-
-        return <SelectInput {...props} options={options} />;
-      },
-    }),
-    createSurface({
-      id: POPOVER_RENAME_SPACE,
-      role: 'popover',
-      filter: (data): data is { props: Space } => data.component === POPOVER_RENAME_SPACE && isSpace(data.props),
-      component: ({ data }) => <PopoverRenameSpace space={data.props} />,
-    }),
-    createSurface({
-      id: POPOVER_RENAME_OBJECT,
-      role: 'popover',
-      filter: (data): data is { props: Obj.Any } =>
-        data.component === POPOVER_RENAME_OBJECT && isLiveObject(data.props),
-      component: ({ data }) => <PopoverRenameObject object={data.props} />,
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/menu-footer`,
-      role: 'menu-footer',
-      filter: (data): data is { subject: Obj.Any } => Obj.isObject(data.subject),
-      component: ({ data }) => <MenuFooter object={data.subject} />,
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/navtree-presence`,
-      role: 'navtree-item-end',
-      filter: (data): data is { id: string; subject: Obj.Any; open?: boolean } =>
-        typeof data.id === 'string' && Obj.isObject(data.subject),
-      component: ({ data }) => {
-        // TODO(wittjosiah): Doesn't need to be mutable but readonly type messes with ComplexMap.
-        const state = useCapability(SpaceCapabilities.MutableState);
-        return <SmallPresenceLive id={data.id} open={data.open} viewers={state.viewersByObject[data.id]} />;
-      },
-    }),
-    // TODO(wittjosiah): Attention glyph for non-echo items should be handled elsewhere.
-    createSurface({
-      id: `${SPACE_PLUGIN}/navtree-presence-fallback`,
-      role: 'navtree-item-end',
-      position: 'fallback',
-      filter: (data): data is { id: string; open?: boolean } => typeof data.id === 'string',
-      component: ({ data }) => <SmallPresenceLive id={data.id} open={data.open} />,
-    }),
-    // TODO(wittjosiah): Broken?
-    createSurface({
-      id: `${SPACE_PLUGIN}/navtree-sync-status`,
-      role: 'navtree-item-end',
-      filter: (data): data is { subject: Space; open?: boolean } => isSpace(data.subject),
-      component: ({ data }) => <InlineSyncStatus space={data.subject} open={data.open} />,
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/navbar-presence`,
-      role: 'navbar-end',
-      position: 'hoist',
-      filter: (data): data is { subject: Space | Obj.Any } => isSpace(data.subject) || Obj.isObject(data.subject),
-      component: ({ data }) => {
-        const space = isSpace(data.subject) ? data.subject : getSpace(data.subject);
-        const object = isSpace(data.subject)
-          ? data.subject.state.get() === SpaceState.SPACE_READY
-            ? (space?.properties[Type.getTypename(DataType.Collection)]?.target as DataType.Collection)
-            : undefined
-          : data.subject;
-
-        return object ? <SpacePresence object={object} /> : null;
-      },
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/collection-section`,
-      role: 'section',
-      filter: (data): data is { subject: DataType.Collection } => Obj.instanceOf(DataType.Collection, data.subject),
-      component: ({ data }) => <CollectionSection collection={data.subject} />,
-    }),
-    createSurface({
-      id: `${SPACE_PLUGIN}/status`,
-      role: 'status',
-      component: () => <SyncStatus />,
-    }),
-  ]);

package/src/capabilities/schema-defs.ts

@@ -1,30 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, contributes, type PluginContext } from '@dxos/app-framework';
-import { ClientCapabilities } from '@dxos/plugin-client';
-
-import { SpaceCapabilities } from './capabilities';
-import { type ObjectForm } from '../types';
-
-export default (context: PluginContext) => {
-  const registry = context.getCapability(Capabilities.RxRegistry);
-  const client = context.getCapability(ClientCapabilities.Client);
-
-  // TODO(wittjosiah): Unregister schemas when they are disabled.
-  let previous: ObjectForm[] = [];
-  const cancel = registry.subscribe(
-    context.capabilities(SpaceCapabilities.ObjectForm),
-    (_forms) => {
-      const forms = Array.from(new Set(_forms));
-      // TODO(wittjosiah): Filter out schemas which the client has already registered.
-      const newSchemas = forms.filter((form) => !previous.includes(form)).map((form) => form.objectSchema);
-      previous = forms;
-      client.addTypes(newSchemas);
-    },
-    { immediate: true },
-  );
-
-  return contributes(Capabilities.Null, null, () => cancel());
-};

package/src/capabilities/schema-tool.test.ts

@@ -1,44 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Schema } from 'effect';
-import { describe, it, expect } from 'vitest';
-
-import { TypeNameSchema } from './schema-tools';
-
-describe('TypeNameSchema format', () => {
-  const valid = [
-    'example.com/usCities',
-    'dxos.org/Contact',
-    'dxos.org/Table',
-    'dxos.org/Table/Contact',
-    'dxos.org/PluginName/TypeName',
-    // Case variations
-    'DXOS.org/Table',
-    'dxos.ORG/table',
-  ];
-
-  const invalid = [
-    'http://dxos.org/Table', // No protocol allowed
-    'dxos.org/', // Must have type path
-    // TODO(dmaretskyi): Decide if we want to ban numbers.
-    // 'dxos.org/1Type', // Path segments must start with letter
-    'dxos.org/Type!', // Invalid character
-    '.org/Type', // Must have domain
-  ];
-
-  const validate = Schema.validateSync(TypeNameSchema);
-
-  valid.forEach((typename) => {
-    it(`should accept valid typename: ${typename}`, () => {
-      expect(() => validate(typename)).not.toThrow();
-    });
-  });
-
-  invalid.forEach((typename) => {
-    it(`should reject invalid typename: ${typename}`, () => {
-      expect(() => validate(typename)).toThrow();
-    });
-  });
-});

package/src/capabilities/schema-tools.ts

@@ -1,125 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Schema, SchemaAST } from 'effect';
-
-import { createTool, ToolResult } from '@dxos/ai';
-import { Capabilities, contributes, type PromiseIntentDispatcher } from '@dxos/app-framework';
-import { type Space } from '@dxos/client/echo';
-import { Type } from '@dxos/echo';
-import { FormatEnum, FormatEnums, SelectOptionSchema } from '@dxos/echo-schema';
-import { invariant } from '@dxos/invariant';
-import { hues } from '@dxos/react-ui-theme';
-import { getSchemaFromPropertyDefinitions } from '@dxos/schema';
-
-// TODO(burdon): Factor out.
-declare global {
-  interface ToolContextExtensions {
-    space?: Space;
-    dispatch?: PromiseIntentDispatcher;
-  }
-}
-
-// TODO(ZaymonFC): Move this somewhere common.
-export const TypeNameSchema = Schema.String.pipe(
-  Schema.pattern(/^\w+\.\w{2,}\/[\w/]+$/i),
-  Schema.annotations({
-    title: 'TypeName',
-    description:
-      'Domain-style type name path. Dashes are not allowed. Use camel case for the final component of the type name.',
-    [SchemaAST.ExamplesAnnotationId]: ['example.com/type/Document', 'example.com/type/FlightList'],
-  }),
-);
-
-const formatDescription = `The format of the property. Additional information:
-  ${FormatEnum.GeoPoint}: ${JSON.stringify(Type.toJsonSchema(Type.Format.GeoPoint))}
-  This tuple is GeoJSON. You must specify \`${FormatEnum.GeoPoint}\` as [Longitude, Latitude]`;
-
-// TODO(ZaymonFC): All properties are default optional, but maybe we should allow for required properties.
-const PropertyDefinitionSchema = Schema.Struct({
-  name: Schema.String.annotations({ description: 'The name of the property.' }),
-  format: Schema.Union(...FormatEnums.map((format) => Schema.Literal(format))).annotations({
-    description: formatDescription,
-  }),
-  config: Schema.optional(
-    Schema.Struct({
-      options: Schema.optional(
-        Schema.Array(SelectOptionSchema)
-          .annotations({
-            description: `Options for SingleSelect/MultiSelect formats. Available colors: ${hues.join(', ')}`,
-          })
-          .pipe(Schema.mutable),
-      ),
-    }),
-  ),
-}).pipe(Schema.mutable);
-
-const SYSTEM_NAMESPACE = 'dxos.org/echo/schema';
-
-export default () =>
-  contributes(Capabilities.Tools, [
-    createTool(SYSTEM_NAMESPACE, {
-      name: 'list',
-      description: 'List registered schemas in the space.',
-      caption: 'Listing registered schemas...',
-      schema: Schema.Struct({}),
-      execute: async (_input, { extensions }) => {
-        invariant(extensions?.space, 'No space.');
-        const space = extensions.space;
-
-        const schemas = await space.db.schemaRegistry.query({}).run();
-        return ToolResult.Success(
-          schemas.map((schema) => ({
-            typename: schema.typename,
-            version: schema.version,
-          })),
-        );
-      },
-    }),
-    createTool(SYSTEM_NAMESPACE, {
-      name: 'get',
-      description: 'Get a specific schema by its typename.',
-      caption: 'Getting schema...',
-      schema: Schema.Struct({
-        typename: Schema.String.annotations({
-          description: 'The fully qualified typename of the schema.',
-        }),
-      }),
-      execute: async ({ typename }, { extensions }) => {
-        invariant(extensions?.space, 'No space.');
-        const space = extensions.space;
-
-        const schema = await space.db.schemaRegistry.query({ typename }).firstOrUndefined();
-        if (!schema) {
-          return ToolResult.Error(`Schema not found: ${typename}`);
-        }
-
-        return ToolResult.Success(schema);
-      },
-    }),
-    createTool(SYSTEM_NAMESPACE, {
-      name: 'create',
-      description: 'Create a new schema with the provided definition.',
-      caption: 'Creating schema...',
-      schema: Schema.Struct({
-        typename: TypeNameSchema.annotations({
-          description:
-            'The fully qualified schema typename. Must start with a domain, and then one or more path components (e.g., "example.com/type/TypeName").',
-        }),
-        properties: Schema.Array(PropertyDefinitionSchema).pipe(
-          Schema.annotations({ description: 'Array of property definitions for the schema.' }),
-          Schema.mutable,
-        ),
-      }),
-      execute: async ({ typename, properties }, { extensions }) => {
-        invariant(extensions?.space, 'No space.');
-        const space = extensions.space;
-
-        const schema = getSchemaFromPropertyDefinitions(typename, properties);
-        const [registeredSchema] = await space.db.schemaRegistry.register([schema]);
-
-        return ToolResult.Success(registeredSchema);
-      },
-    }),
-  ]);

package/src/capabilities/settings.ts

@@ -1,21 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, contributes } from '@dxos/app-framework';
-import { live } from '@dxos/live-object';
-
-import { meta } from '../meta';
-import { type SpaceSettingsProps, SpaceSettingsSchema } from '../types';
-
-export default () => {
-  const settings = live<SpaceSettingsProps>({
-    showHidden: false,
-  });
-
-  return contributes(Capabilities.Settings, {
-    prefix: meta.id,
-    schema: SpaceSettingsSchema,
-    value: settings,
-  });
-};