@dxos/plugin-space 0.8.3 → 0.8.4-main.03d5cd7b56

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/components/AwaitingObject.tsx

@@ -1,114 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { CheckCircle, CircleDashed, CircleNotch } from '@phosphor-icons/react';
-import React, { useCallback, useEffect, useState } from 'react';
-
-import { createIntent, LayoutAction, useIntentDispatcher, useLayout } from '@dxos/app-framework';
-import { useClient } from '@dxos/react-client';
-import { Filter, fullyQualifiedId, useQuery } from '@dxos/react-client/echo';
-import { Button, Toast, useTranslation } from '@dxos/react-ui';
-import { getSize, mx } from '@dxos/react-ui-theme';
-
-import { SPACE_PLUGIN } from '../meta';
-import { SpaceAction } from '../types';
-
-const WAIT_FOR_OBJECT_TIMEOUT = 180e3; // 3 minutes
-const TOAST_TIMEOUT = 240e3; // 4 minutes
-
-export const AwaitingObject = ({ id }: { id: string }) => {
-  const [open, setOpen] = useState(true);
-  const [waiting, setWaiting] = useState(true);
-  const [found, setFound] = useState(false);
-  const { t } = useTranslation(SPACE_PLUGIN);
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const layout = useLayout();
-
-  const client = useClient();
-  const objects = useQuery(client.spaces, Filter.everything());
-
-  useEffect(() => {
-    if (!id) {
-      return;
-    }
-
-    const timeout = setTimeout(() => {
-      setWaiting(false);
-    }, WAIT_FOR_OBJECT_TIMEOUT);
-
-    () => clearTimeout(timeout);
-  }, [id]);
-
-  useEffect(() => {
-    if (objects.findIndex((object) => fullyQualifiedId(object) === id) > -1) {
-      setFound(true);
-
-      if (layout.active.includes(id)) {
-        setOpen(false);
-      }
-    }
-  }, [id, objects, layout]);
-
-  const handleClose = useCallback(
-    async () => dispatch(createIntent(SpaceAction.WaitForObject, { id: undefined })),
-    [dispatch],
-  );
-
-  const handleNavigate = useCallback(() => {
-    void dispatch(createIntent(LayoutAction.Open, { part: 'main', subject: [id] }));
-    void handleClose();
-  }, [id, handleClose, dispatch]);
-
-  return (
-    <Toast.Root open={open} duration={TOAST_TIMEOUT} onOpenChange={setOpen}>
-      <Toast.Body>
-        <Toast.Title classNames='flex items-center gap-2'>
-          {found ? (
-            <>
-              <CheckCircle className={getSize(5)} />
-              <span>{t('found object label')}</span>
-            </>
-          ) : waiting ? (
-            <>
-              <CircleNotch className={mx(getSize(5), 'animate-spin')} />
-              <span>{t('waiting for object label')}</span>
-            </>
-          ) : (
-            <>
-              <CircleDashed className={getSize(5)} />
-              <span>{t('object not found label')}</span>
-            </>
-          )}
-        </Toast.Title>
-        <Toast.Description>
-          {t(
-            found
-              ? 'found object description'
-              : waiting
-                ? 'waiting for object description'
-                : 'object not found description',
-          )}
-        </Toast.Description>
-      </Toast.Body>
-      <Toast.Actions>
-        {found ? (
-          <>
-            <Toast.Action altText={t('go to object alt')} asChild>
-              <Button variant='primary' onClick={handleNavigate}>
-                {t('go to object label')}
-              </Button>
-            </Toast.Action>
-            <Toast.Close asChild>
-              <Button onClick={handleClose}>{t('close label', { ns: 'appkit' })}</Button>
-            </Toast.Close>
-          </>
-        ) : (
-          <Toast.Close asChild>
-            <Button onClick={handleClose}>{t(waiting ? 'close label' : 'confirm label', { ns: 'appkit' })}</Button>
-          </Toast.Close>
-        )}
-      </Toast.Actions>
-    </Toast.Root>
-  );
-};

package/src/components/CollectionMain.tsx

@@ -1,30 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import { useTranslation } from '@dxos/react-ui';
-import { baseSurface, descriptionMessage, mx } from '@dxos/react-ui-theme';
-import { type DataType } from '@dxos/schema';
-
-import { SPACE_PLUGIN } from '../meta';
-
-export const CollectionMain = ({ collection }: { collection: DataType.Collection }) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
-
-  return (
-    <div
-      role='none'
-      className={mx(baseSurface, 'min-bs-screen is-full flex items-center justify-center p-8')}
-      data-testid='composer.firstRunMessage'
-    >
-      <p
-        role='alert'
-        className={mx(descriptionMessage, 'rounded-md p-8 font-normal text-lg max-is-[24rem] break-words')}
-      >
-        {collection.name ?? t('unnamed collection label')}
-      </p>
-    </div>
-  );
-};

package/src/components/CollectionSection.tsx

@@ -1,20 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import { useTranslation } from '@dxos/react-ui';
-import { type DataType } from '@dxos/schema';
-
-import { SPACE_PLUGIN } from '../meta';
-
-export const CollectionSection = ({ collection }: { collection: DataType.Collection }) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
-  // TODO(wittjosiah): Better placeholder.
-  return (
-    <div className='min-bs-[3.5rem] grid grid-rows-subgrid grid-cols-subgrid items-center'>
-      <span className='truncate'>{collection.name ?? t('unnamed collection label')}</span>
-    </div>
-  );
-};

package/src/components/CreateDialog/CreateObjectDialog.stories.tsx

@@ -1,84 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type Meta, type StoryObj } from '@storybook/react';
-import React, { useEffect } from 'react';
-
-import { Filter, Obj, Type } from '@dxos/echo';
-import { useQuery, useSpace } from '@dxos/react-client/echo';
-import { withClientProvider } from '@dxos/react-client/testing';
-import { Dialog } from '@dxos/react-ui';
-import { DataType } from '@dxos/schema';
-import { osTranslations } from '@dxos/shell/react';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
-
-import { CreateObjectDialog, type CreateObjectDialogProps } from './CreateObjectDialog';
-import translations from '../../translations';
-
-const Story = (args: CreateObjectDialogProps) => {
-  return (
-    <Dialog.Root open>
-      <Dialog.Overlay blockAlign='start'>
-        <CreateObjectDialog {...args} />
-      </Dialog.Overlay>
-    </Dialog.Root>
-  );
-};
-
-// TODO(wittjosiah): Story should be for CreateObjectPanel.
-const meta: Meta<typeof CreateObjectDialog> = {
-  title: 'plugins/plugin-space/CreateObjectDialog',
-  component: CreateObjectDialog,
-  render: Story,
-  decorators: [
-    withClientProvider({ createIdentity: true, createSpace: true, types: [DataType.Collection] }),
-    withTheme,
-    withLayout(),
-  ],
-  parameters: {
-    translations: [...translations, osTranslations],
-  },
-  args: {},
-};
-
-export default meta;
-
-export const Default: StoryObj<typeof CreateObjectDialog> = {};
-
-export const Typename: StoryObj<typeof CreateObjectDialog> = {
-  args: { typename: Type.getTypename(DataType.Collection) },
-};
-
-export const TargetSpace: StoryObj<typeof CreateObjectDialog> = {
-  render: (args) => {
-    const space = useSpace();
-
-    if (!space) {
-      return <></>;
-    }
-
-    return <Story {...args} target={space} />;
-  },
-};
-
-export const TargetCollection: StoryObj<typeof CreateObjectDialog> = {
-  render: (args) => {
-    const space = useSpace();
-    const [collection] = useQuery(space, Filter.type(DataType.Collection));
-
-    useEffect(() => {
-      if (space) {
-        space.db.add(Obj.make(DataType.Collection, { name: 'My Collection', objects: [] }));
-      }
-    }, [space]);
-
-    if (!collection) {
-      return <></>;
-    }
-
-    return <Story {...args} target={collection} />;
-  },
-};

package/src/components/CreateDialog/CreateObjectDialog.tsx

@@ -1,120 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { pipe } from 'effect';
-import React, { useCallback, useRef, useState } from 'react';
-
-import {
-  Capabilities,
-  LayoutAction,
-  chain,
-  createIntent,
-  useCapabilities,
-  useIntentDispatcher,
-  usePluginManager,
-} from '@dxos/app-framework';
-import { Query, Type, type Obj } from '@dxos/echo';
-import { invariant } from '@dxos/invariant';
-import { useClient } from '@dxos/react-client';
-import { getSpace, isLiveObject, isSpace, type Space, useQuery, useSpaces } from '@dxos/react-client/echo';
-import { Button, Dialog, Icon, useTranslation } from '@dxos/react-ui';
-import { cardDialogContent, cardDialogHeader } from '@dxos/react-ui-stack';
-import { DataType } from '@dxos/schema';
-import { isNonNullable } from '@dxos/util';
-
-import { CreateObjectPanel, type CreateObjectPanelProps } from './CreateObjectPanel';
-import { SpaceCapabilities } from '../../capabilities';
-import { SPACE_PLUGIN } from '../../meta';
-import { SpaceAction } from '../../types';
-
-export const CREATE_OBJECT_DIALOG = `${SPACE_PLUGIN}/CreateObjectDialog`;
-
-export type CreateObjectDialogProps = Pick<CreateObjectPanelProps, 'target' | 'typename' | 'name'> & {
-  shouldNavigate?: (object: Obj.Any) => boolean;
-};
-
-export const CreateObjectDialog = ({
-  target: initialTarget,
-  typename: initialTypename,
-  name,
-  shouldNavigate: _shouldNavigate,
-}: CreateObjectDialogProps) => {
-  const closeRef = useRef<HTMLButtonElement | null>(null);
-  const manager = usePluginManager();
-  const { t } = useTranslation(SPACE_PLUGIN);
-  const client = useClient();
-  const spaces = useSpaces();
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const forms = useCapabilities(SpaceCapabilities.ObjectForm);
-  const [target, setTarget] = useState<Space | DataType.Collection | undefined>(initialTarget);
-  const [typename, setTypename] = useState<string | undefined>(initialTypename);
-  const space = isSpace(target) ? target : getSpace(target);
-  const queryCollections = useQuery(space, Query.type(DataType.QueryCollection));
-  const hiddenTypenames = queryCollections.map((collection) => collection.query.typename).filter(isNonNullable);
-
-  const resolve = useCallback<NonNullable<CreateObjectPanelProps['resolve']>>(
-    (typename) =>
-      manager.context.getCapabilities(Capabilities.Metadata).find(({ id }) => id === typename)?.metadata ?? {},
-    [manager],
-  );
-
-  const handleCreateObject = useCallback<NonNullable<CreateObjectPanelProps['onCreateObject']>>(
-    async ({ form, data = {} }) => {
-      if (!target) {
-        // TODO(wittjosiah): UI feedback.
-        return;
-      }
-
-      // NOTE: Must close before navigating or attention won't follow object.
-      closeRef.current?.click();
-
-      const space = isSpace(target) ? target : getSpace(target);
-      invariant(space, 'Missing space');
-      const result = await dispatch(form.getIntent(data, { space }));
-      const object = result.data?.object;
-      if (isLiveObject(object)) {
-        // TODO(wittjosiah): Selection in navtree isn't working as expected when hidden typenames evals to true.
-        const hidden = form.hidden || hiddenTypenames.includes(Type.getTypename(form.objectSchema));
-        const addObjectIntent = createIntent(SpaceAction.AddObject, { target, object, hidden });
-        const shouldNavigate = _shouldNavigate ?? (() => true);
-        if (shouldNavigate(object)) {
-          await dispatch(pipe(addObjectIntent, chain(LayoutAction.Open, { part: 'main' })));
-        } else {
-          await dispatch(addObjectIntent);
-        }
-      }
-    },
-    [dispatch, target, resolve, hiddenTypenames, _shouldNavigate],
-  );
-
-  return (
-    // TODO(wittjosiah): The tablist dialog pattern is copied from @dxos/plugin-manager.
-    //  Consider factoring it out to the tabs package.
-    <Dialog.Content classNames={cardDialogContent}>
-      <div role='none' className={cardDialogHeader}>
-        <Dialog.Title>
-          {t('create object dialog title', { object: t('typename label', { ns: typename, defaultValue: 'Item' }) })}
-        </Dialog.Title>
-        <Dialog.Close asChild>
-          <Button ref={closeRef} density='fine' variant='ghost' autoFocus>
-            <Icon icon='ph--x--regular' size={4} />
-          </Button>
-        </Dialog.Close>
-      </div>
-
-      <CreateObjectPanel
-        forms={forms}
-        spaces={spaces}
-        target={target}
-        typename={typename}
-        name={name}
-        defaultSpaceId={client.spaces.default.id}
-        resolve={resolve}
-        onTargetChange={setTarget}
-        onTypenameChange={setTypename}
-        onCreateObject={handleCreateObject}
-      />
-    </Dialog.Content>
-  );
-};

package/src/components/CreateDialog/CreateSpaceDialog.tsx

@@ -1,66 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Effect, type Schema } from 'effect';
-import React, { useCallback, useRef } from 'react';
-
-import { createIntent, LayoutAction, useIntentDispatcher } from '@dxos/app-framework';
-import { Button, Dialog, Icon, useTranslation } from '@dxos/react-ui';
-import { Form } from '@dxos/react-ui-form';
-import { cardDialogContent, cardDialogHeader } from '@dxos/react-ui-stack';
-
-import { useInputSurfaceLookup } from '../../hooks';
-import { SPACE_PLUGIN } from '../../meta';
-import { SpaceAction, SpaceForm } from '../../types';
-
-export const CREATE_SPACE_DIALOG = `${SPACE_PLUGIN}/CreateSpaceDialog`;
-
-type FormValues = Schema.Schema.Type<typeof SpaceForm>;
-const initialValues: FormValues = { edgeReplication: true };
-
-export const CreateSpaceDialog = () => {
-  const closeRef = useRef<HTMLButtonElement | null>(null);
-  const { t } = useTranslation(SPACE_PLUGIN);
-  const { dispatch } = useIntentDispatcher();
-
-  const inputSurfaceLookup = useInputSurfaceLookup();
-
-  const handleCreateSpace = useCallback(
-    async (data: FormValues) => {
-      const program = Effect.gen(function* () {
-        const { space } = yield* dispatch(createIntent(SpaceAction.Create, data));
-        yield* dispatch(createIntent(LayoutAction.SwitchWorkspace, { part: 'workspace', subject: space.id }));
-        yield* dispatch(createIntent(LayoutAction.UpdateDialog, { part: 'dialog', options: { state: false } }));
-      });
-      await Effect.runPromise(program);
-    },
-    [dispatch],
-  );
-
-  return (
-    // TODO(wittjosiah): The tablist dialog pattern is copied from @dxos/plugin-manager.
-    //  Consider factoring it out to the tabs package.
-    <Dialog.Content classNames={cardDialogContent}>
-      <div role='none' className={cardDialogHeader}>
-        <Dialog.Title>{t('create space dialog title')}</Dialog.Title>
-        <Dialog.Close asChild>
-          <Button ref={closeRef} density='fine' variant='ghost' autoFocus>
-            <Icon icon='ph--x--regular' size={4} />
-          </Button>
-        </Dialog.Close>
-      </div>
-      <div role='none' className='contents'>
-        <Form
-          testId='create-space-form'
-          autoFocus
-          values={initialValues}
-          schema={SpaceForm}
-          lookupComponent={inputSurfaceLookup}
-          onSave={handleCreateSpace}
-          outerSpacing='scroll-fields'
-        />
-      </div>
-    </Dialog.Content>
-  );
-};

package/src/components/MembersContainer.stories.tsx

@@ -1,30 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type StoryObj, type Meta } from '@storybook/react';
-
-import { withClientProvider } from '@dxos/react-client/testing';
-import { osTranslations } from '@dxos/shell/react';
-import { withTheme, withLayout } from '@dxos/storybook-utils';
-
-import { MembersContainer } from './MembersContainer';
-import translations from '../translations';
-
-const meta: Meta = {
-  title: 'plugins/plugin-space/MembersContainer',
-  component: MembersContainer,
-  decorators: [withClientProvider({ createIdentity: true, createSpace: true }), withTheme, withLayout()],
-  parameters: {
-    layout: 'fullscreen',
-    translations: [...translations, osTranslations],
-  },
-};
-
-export default meta;
-
-type Story = StoryObj<typeof MembersContainer>;
-
-export const Default: Story = {};