@dxos/plugin-space 0.8.4-main.4a85c3132b → 0.8.4-main.4f23b4e393

package/src/types/capabilities.ts

@@ -5,22 +5,23 @@
 import { type Atom } from '@effect-atom/atom-react';
 import type * as Effect from 'effect/Effect';
 import * as Schema from 'effect/Schema';
+import type { ComponentType } from 'react';
 
 import { Capability } from '@dxos/app-framework';
 import { type Space } from '@dxos/client/echo';
-import { type Database } from '@dxos/echo';
-import { type Collection } from '@dxos/echo';
+import { type Operation } from '@dxos/compute';
+import { type Collection, type Database } from '@dxos/echo';
 import { type PublicKey } from '@dxos/keys';
-import { type Operation } from '@dxos/operation';
-import { type Label } from '@dxos/ui-types';
+import { type Label } from '@dxos/ui-types/translations';
 import { type ComplexMap, type Position } from '@dxos/util';
 
-import { meta } from '../meta';
+import { meta } from '#meta';
 
-import { type ObjectViewerProps, type SpaceSettingsProps } from './types';
+import * as Settings from './Settings';
+import { type CreateObject, type ObjectViewerProps } from './types';
 
 export namespace SpaceCapabilities {
-  export const Settings = Capability.make<Atom.Writable<SpaceSettingsProps>>(`${meta.id}/capability/settings`);
+  export const Settings = Capability.make<Atom.Writable<Settings.Settings>>(`${meta.id}.capability.settings`);
 
   /** Schema for persisted space plugin state. */
   export const StateSchema = Schema.mutable(
@@ -33,7 +34,7 @@ export namespace SpaceCapabilities {
   export type SpaceState = Schema.Schema.Type<typeof StateSchema>;
 
   /** Persisted state (stored in KVS/localStorage). */
-  export const State = Capability.make<Atom.Writable<SpaceState>>(`${meta.id}/capability/state`);
+  export const State = Capability.make<Atom.Writable<SpaceState>>(`${meta.id}.capability.state`);
 
   /** Ephemeral space plugin state (not persisted). */
   export type SpaceEphemeralState = {
@@ -46,18 +47,18 @@ export namespace SpaceCapabilities {
 
   /** Transient/ephemeral state (not persisted). */
   export const EphemeralState = Capability.make<Atom.Writable<SpaceEphemeralState>>(
-    `${meta.id}/capability/ephemeral-state`,
+    `${meta.id}.capability.ephemeral-state`,
   );
 
   export type SettingsSection = { id: string; label: Label; position?: Position };
-  export const SettingsSection = Capability.make<SettingsSection>(`${meta.id}/capability/settings-section`);
+  export const SettingsSection = Capability.make<SettingsSection>(`${meta.id}.capability.settings-section`);
 
   export type OnCreateSpace = (params: {
     space: Space;
     isDefault: boolean;
     rootCollection: Collection.Collection;
   }) => Effect.Effect<void, Error, Operation.Service>;
-  export const OnCreateSpace = Capability.make<OnCreateSpace>(`${meta.id}/capability/on-space-created`);
+  export const OnCreateSpace = Capability.make<OnCreateSpace>(`${meta.id}.capability.on-space-created`);
 
   export type OnSchemaAdded = (params: {
     db: Database.Database;
@@ -65,9 +66,30 @@ export namespace SpaceCapabilities {
     // TODO(wittjosiah): This is leaky.
     show?: boolean;
   }) => Effect.Effect<void, Error, Operation.Service>;
-  export const OnSchemaAdded = Capability.make<OnSchemaAdded>(`${meta.id}/capability/on-schema-added`);
+  export const OnSchemaAdded = Capability.make<OnSchemaAdded>(`${meta.id}.capability.on-schema-added`);
 
   // TODO(wittjosiah): Replace with migrations, this is not a sustainable solution.
   export type HandleRepair = (params: { space: Space; isDefault: boolean }) => Promise<void>;
-  export const Repair = Capability.make<HandleRepair>(`${meta.id}/capability/repair`);
+  export const Repair = Capability.make<HandleRepair>(`${meta.id}.capability.repair`);
+
+  /** Typed creation entry contributed per typename by plugins that support creating objects. */
+  export type CreateObjectEntry = Readonly<{
+    id: string;
+    createObject: CreateObject;
+    inputSchema?: Schema.Schema.AnyNoContext;
+    /**
+     * Optional custom React panel rendered in place of the default `inputSchema` form.
+     * Lets a plugin own the entire post-typename-selection flow (e.g. multi-stage forms).
+     * `onCreateObject` receives the collected data and triggers the same submit flow.
+     */
+    customPanel?: ComponentType<CreateObjectCustomPanelProps>;
+  }>;
+  export const CreateObjectEntry = Capability.make<CreateObjectEntry>(`${meta.id}.capability.create-object`);
+
+  /** Props passed to a `CreateObjectEntry.customPanel`. */
+  export type CreateObjectCustomPanelProps = {
+    target: Database.Database | Collection.Collection;
+    initialFormValues?: Record<string, any>;
+    onCreateObject: (data: Record<string, any>) => void | Promise<void>;
+  };
 }

package/src/types/events.ts

@@ -5,12 +5,12 @@
 import { ActivationEvent } from '@dxos/app-framework';
 import { AppActivationEvents } from '@dxos/app-toolkit';
 
-import { meta } from '../meta';
+import { meta } from '#meta';
 
 export namespace SpaceEvents {
-  export const StateReady = AppActivationEvents.createStateEvent(`${meta.id}/event/state-ready`);
-  export const SetupSettingsPanel = ActivationEvent.make(`${meta.id}/event/setup-settings-panel`);
-  export const DefaultSpaceReady = ActivationEvent.make(`${meta.id}/event/default-space-ready`);
-  export const SpaceCreated = ActivationEvent.make(`${meta.id}/event/space-created`);
-  export const SchemaAdded = ActivationEvent.make(`${meta.id}/event/schema-added`);
+  export const StateReady = AppActivationEvents.createStateEvent(`${meta.id}.event.state-ready`);
+  export const SetupSettingsPanel = ActivationEvent.make(`${meta.id}.event.setup-settings-panel`);
+  export const PersonalSpaceReady = ActivationEvent.make(`${meta.id}.event.default-space-ready`);
+  export const SpaceCreated = ActivationEvent.make(`${meta.id}.event.space-created`);
+  export const SchemaAdded = ActivationEvent.make(`${meta.id}.event.schema-added`);
 }

package/src/types/form.ts

@@ -2,68 +2,9 @@
 // Copyright 2025 DXOS.org
 //
 
-import * as Option from 'effect/Option';
-import * as Schema from 'effect/Schema';
-
-import { type Space } from '@dxos/client/echo';
-import { Type } from '@dxos/echo';
-import { EntityKind, SystemTypeAnnotation, createAnnotationHelper, getTypeAnnotation } from '@dxos/echo/internal';
-
-export const TypeInputOptions = Schema.Struct({
-  location: Schema.Array(Schema.Literal('database', 'runtime')),
-  kind: Schema.Array(Schema.Literal('system', 'user')),
-  registered: Schema.Array(Schema.Literal('registered', 'unregistered')),
-});
-
-export type TypeInputOptions = Schema.Schema.Type<typeof TypeInputOptions>;
-
-/**
- * Used in forms to identify the field representing an object's type and determine which types are shown as options.
- */
-export const TypeInputOptionsAnnotationId = Symbol.for('@dxos/schema/annotation/TypeInputOptions');
-export const TypeInputOptionsAnnotation = createAnnotationHelper<TypeInputOptions>(TypeInputOptionsAnnotationId);
-
-// TODO(wittjosiah): This is too complicated and needs to be simplified.
-export const getTypenames = ({ annotation, space }: { annotation: TypeInputOptions; space?: Space }) => {
-  const includeRuntime = annotation.location.includes('runtime');
-  const includeDatabase = annotation.location.includes('database');
-  const includeSystemType = annotation.kind.includes('system');
-  const includeUserType = annotation.kind.includes('user');
-  const includeRegistered = annotation.registered.includes('registered');
-  const includeUnregistered = annotation.registered.includes('unregistered');
-
-  const runtimeTypenames =
-    includeRuntime && space
-      ? space.db.schemaRegistry
-          .query({ location: ['runtime'] })
-          .runSync()
-          .filter((schema) => {
-            const relation = getTypeAnnotation(schema)?.kind === EntityKind.Relation;
-            if (relation) {
-              return includeSystemType;
-            }
-
-            const system = SystemTypeAnnotation.get(schema).pipe(Option.getOrElse(() => false));
-            if (system) {
-              return includeSystemType;
-            }
-
-            return includeUserType;
-          })
-          .filter((schema) => {
-            const registered = space?.properties.staticRecords?.includes(Type.getTypename(schema));
-            return registered ? includeRegistered : includeUnregistered;
-          })
-          .map((schema) => Type.getTypename(schema))
-      : [];
-
-  const databaseTypenames =
-    includeDatabase && includeRegistered && space
-      ? space.db.schemaRegistry
-          .query({ location: ['database'] })
-          .runSync()
-          .map((schema) => Type.getTypename(schema))
-      : [];
-
-  return Array.from(new Set<string>([...runtimeTypenames, ...databaseTypenames])).sort();
-};
+export {
+  getTypenames,
+  TypeInputOptions,
+  TypeInputOptionsAnnotation,
+  TypeInputOptionsAnnotationId,
+} from '@dxos/app-toolkit';