@dxos/plugin-space 0.8.4-main.2e9d522 → 0.8.4-main.3c1ae3b

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/MembersContainer.stories.tsx

@@ -1,30 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type StoryObj, type Meta } from '@storybook/react-vite';
-
-import { withClientProvider } from '@dxos/react-client/testing';
-import { translations as shellTranslations } 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, ...shellTranslations],
-  },
-};
-
-export default meta;
-
-type Story = StoryObj<typeof MembersContainer>;
-
-export const Default: Story = {};

package/src/components/ObjectDetailsPanel.tsx

@@ -1,77 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useCallback } from 'react';
-
-import { type JsonPath, setValue } from '@dxos/echo-schema';
-import { invariant } from '@dxos/invariant';
-import { useClient } from '@dxos/react-client';
-import { getSpace, Filter, useQuery, useSchema } from '@dxos/react-client/echo';
-import { Callout, useTranslation } from '@dxos/react-ui';
-import { useSelected } from '@dxos/react-ui-attention';
-import { Form, useRefQueryLookupHandler } from '@dxos/react-ui-form';
-import { type DataType } from '@dxos/schema';
-import { isNonNullable } from '@dxos/util';
-
-import { SPACE_PLUGIN } from '../meta';
-
-type RowDetailsPanelProps = { objectId: string; view: DataType.View };
-
-const ObjectDetailsPanel = ({ objectId, view }: RowDetailsPanelProps) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
-  const client = useClient();
-  const space = getSpace(view);
-  const schema = useSchema(client, space, view.query?.typename);
-
-  const queriedObjects = useQuery(space, schema ? Filter.type(schema) : Filter.nothing());
-  const selectedRows = useSelected(objectId, 'multi');
-  const selectedObjects = selectedRows.map((id) => queriedObjects.find((obj) => obj.id === id)).filter(isNonNullable);
-
-  const handleRefQueryLookup = useRefQueryLookupHandler({ space });
-
-  const handleSave = useCallback(
-    (values: any, { changed }: { changed: Record<JsonPath, boolean> }) => {
-      const id = values.id;
-      invariant(typeof id === 'string');
-      const object = queriedObjects.find((obj) => obj.id === id);
-      invariant(object);
-
-      const changedPaths = Object.keys(changed).filter((path) => changed[path as JsonPath]) as JsonPath[];
-      for (const path of changedPaths) {
-        const value = values[path];
-        setValue(object, path, value);
-      }
-    },
-    [queriedObjects],
-  );
-
-  if (selectedObjects.length === 0) {
-    return (
-      <div role='none' className='plb-cardSpacingBlock pli-cardSpacingInline'>
-        <Callout.Root classNames='is-full'>
-          <Callout.Title>{t('row details no selection label')}</Callout.Title>
-        </Callout.Root>
-      </div>
-    );
-  }
-
-  return (
-    <div role='none' className='bs-full is-full flex flex-col p-2 gap-1 overflow-y-auto'>
-      {schema &&
-        selectedObjects.map((object) => (
-          <div key={object.id} className='border border-separator rounded'>
-            <Form
-              autoSave
-              schema={schema}
-              values={object}
-              onSave={handleSave}
-              onQueryRefOptions={handleRefQueryLookup}
-            />
-          </div>
-        ))}
-    </div>
-  );
-};
-
-export default ObjectDetailsPanel;

package/src/components/ObjectSettings/AdvancedObjectSettings.tsx

@@ -1,80 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useCallback, useState } from 'react';
-
-import { Obj } from '@dxos/echo';
-import { ForeignKey } from '@dxos/echo-schema';
-import { IconButton, useTranslation } from '@dxos/react-ui';
-import { Form } from '@dxos/react-ui-form';
-
-import { ForeignKeys } from './ForeignKeys';
-import { SPACE_PLUGIN } from '../../meta';
-
-const initialValues = {
-  source: '',
-  id: '',
-};
-
-export type AdvancedObjectSettingsProps = {
-  object: Obj.Any;
-};
-
-export const AdvancedObjectSettings = ({ object }: AdvancedObjectSettingsProps) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
-  const [adding, setAdding] = useState(false);
-  const { keys } = Obj.getMeta(object);
-
-  const handleNew = useCallback(() => setAdding(true), []);
-  const handleCancel = useCallback(() => setAdding(false), []);
-  const handleSave = useCallback(
-    (key: ForeignKey) => {
-      const index = keys.findIndex(({ source, id }) => source === key.source && id === key.id);
-      if (index === -1) {
-        keys.push(key);
-      }
-      setAdding(false);
-    },
-    [keys],
-  );
-  const handleDelete = useCallback(
-    (key: ForeignKey) => {
-      const index = keys.findIndex(({ source, id }) => source === key.source && id === key.id);
-      if (index !== -1) {
-        keys.splice(index, 1);
-      }
-    },
-    [keys],
-  );
-
-  // TODO(wittjosiah): This should be wrapped in an "Advanced" accordion.
-  return (
-    <>
-      <div className='p-2 flex flex-col gap-4'>
-        <h2>{t('advanced settings label')}</h2>
-        <div className='flex items-center'>
-          <h3 className='text-sm font-semibold'>{t('foreign keys')}</h3>
-          <div className='grow' />
-          <IconButton
-            classNames={adding && 'invisible'}
-            icon='ph--plus--regular'
-            label={t('add key')}
-            onClick={handleNew}
-          />
-        </div>
-        {!adding && <ForeignKeys keys={keys} onDelete={handleDelete} />}
-      </div>
-
-      {adding && (
-        <Form
-          outerSpacing={false}
-          schema={ForeignKey}
-          values={initialValues}
-          onSave={handleSave}
-          onCancel={handleCancel}
-        />
-      )}
-    </>
-  );
-};

package/src/components/ObjectSettings/BaseObjectSettings.tsx

@@ -1,47 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { type PropsWithChildren, useRef } from 'react';
-
-import { type Obj } from '@dxos/echo';
-import { Input, type ThemedClassName, useTranslation } from '@dxos/react-ui';
-
-import { meta } from '../../meta';
-
-export type BaseObjectSettingsProps = ThemedClassName<
-  PropsWithChildren<{
-    object: Obj.Any;
-  }>
->;
-
-export const BaseObjectSettings = ({ classNames, children, object }: BaseObjectSettingsProps) => {
-  const { t } = useTranslation(meta.id);
-  const inputRef = useRef<HTMLInputElement>(null);
-
-  // TODO(wittjosiah): This should be a form based on the schema of the object.
-  //  The form should only include fields with a specific settings annotation.
-  //  Perhaps also including the field of the title annotation as well.
-  return (
-    <>
-      <Input.Root>
-        <Input.Label>{t('name label')}</Input.Label>
-        <Input.TextInput
-          ref={inputRef}
-          placeholder={t('name placeholder')}
-          // TODO(burdon): Use annotation to get the name field.
-          value={(object as any).name ?? ''}
-          onChange={(event) => {
-            (object as any).name = event.target.value;
-          }}
-          onKeyDown={(event) => {
-            if (event.key === 'Enter') {
-              inputRef.current?.blur();
-            }
-          }}
-        />
-      </Input.Root>
-      {children}
-    </>
-  );
-};

package/src/components/ObjectSettings/ObjectSettingsContainer.tsx

@@ -1,36 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useMemo } from 'react';
-
-import { Surface } from '@dxos/app-framework';
-import { type Obj } from '@dxos/echo';
-import { Clipboard } from '@dxos/react-ui';
-import { StackItem } from '@dxos/react-ui-stack';
-
-import { BaseObjectSettings } from './BaseObjectSettings';
-
-export type ObjectSettingsContainerProps = {
-  object: Obj.Any;
-  role: string;
-};
-
-export const ObjectSettingsContainer = ({ object, role }: ObjectSettingsContainerProps) => {
-  const data = useMemo(() => ({ subject: object }), [object]);
-
-  return (
-    <Clipboard.Provider>
-      <StackItem.Content toolbar={false}>
-        <div role='none' className='overflow-y-auto pli-cardSpacingInline plb-cardSpacingBlock'>
-          <BaseObjectSettings object={object}>
-            <Surface role='base-object-settings' data={data} />
-          </BaseObjectSettings>
-          <Surface role='object-settings' data={data} />
-          {/* TODO(wittjosiah): Remove? */}
-          {/* <AdvancedObjectSettings object={object} /> */}
-        </div>
-      </StackItem.Content>
-    </Clipboard.Provider>
-  );
-};

package/src/components/ObjectSettings/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export * from './ObjectSettingsContainer';

package/src/components/PersistenceStatus.tsx

@@ -1,83 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useEffect, useState } from 'react';
-
-import { debounce } from '@dxos/async';
-import { type EchoDatabase } from '@dxos/react-client/echo';
-import { Icon, Tooltip, useTranslation } from '@dxos/react-ui';
-import { mx, staticPlaceholderText, warningText } from '@dxos/react-ui-theme';
-
-import { SPACE_PLUGIN } from '../meta';
-
-enum Status {
-  PERSISTED_LOCALLY = 0,
-  PENDING = 1,
-  ERROR = 2,
-}
-
-// TODO(zan): This now has no usages. Remove it?
-export const PersistenceStatus = ({ db }: { db: EchoDatabase }) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
-  const [displayMessage, setDisplayMessage] = useState(false);
-  const [status, naturalSetStatus] = useState<Status>(Status.PERSISTED_LOCALLY);
-  const [prevStatus, setPrevStatus] = useState<Status>(Status.PERSISTED_LOCALLY);
-  const _setStatus = debounce(naturalSetStatus, 500);
-
-  // TODO(dmaretskyi): Fix this when we have save status for automerge.
-  // useEffect(() => {
-  //   return db.pendingBatch.on(({ duration, error }) => {
-  //     if (error) {
-  //       setStatus(Status.ERROR);
-  //     } else if (duration === undefined) {
-  //       setStatus(Status.PENDING);
-  //     } else {
-  //       setStatus(Status.PERSISTED_LOCALLY);
-  //     }
-  //   });
-  // }, [db]);
-
-  useEffect(() => {
-    // If this is changed outside the effect it's batched with setStatus and the following condition will never be true.
-    setPrevStatus(status);
-
-    if (prevStatus !== status && status === Status.PERSISTED_LOCALLY) {
-      setDisplayMessage(true);
-      const timeout = setTimeout(() => setDisplayMessage(false), 5000);
-      return () => clearTimeout(timeout);
-    }
-  }, [status]); // `prevStatus` omitted from dependency array to prevent timeout from being reset.
-
-  switch (status) {
-    case Status.ERROR:
-      return (
-        <div className='flex items-center'>
-          <Icon icon='ph--warning--regular' size={4} classNames='me-1' />
-          <span className={mx('text-sm', warningText)}>{t('persistence error label')}</span>
-        </div>
-      );
-    case Status.PENDING:
-      return (
-        <div className='flex items-center'>
-          <Icon icon='ph--arrows-counter-clockwise--regular' size={4} classNames='me-1' />
-          <span className={mx('text-sm', staticPlaceholderText)}>{t('persistence pending label')}</span>
-        </div>
-      );
-    case Status.PERSISTED_LOCALLY:
-    default:
-      return (
-        <Tooltip.Trigger
-          delayDuration={400}
-          role='status'
-          content={t('persisted locally message')}
-          className='flex items-center'
-        >
-          <Icon icon='ph--check-circle--regular' size={4} classNames='me-1' />
-          {displayMessage && (
-            <span className={mx('text-sm', staticPlaceholderText)}>{t('persisted locally label')}</span>
-          )}
-        </Tooltip.Trigger>
-      );
-  }
-};