@dxos/plugin-space 0.8.4-main.c4373fc → 0.8.4-main.d05673bc65

package/src/types/capabilities.ts

@@ -0,0 +1,73 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Atom } from '@effect-atom/atom-react';
+import type * as Effect from 'effect/Effect';
+import * as Schema from 'effect/Schema';
+
+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 PublicKey } from '@dxos/keys';
+import { type Operation } from '@dxos/operation';
+import { type Label } from '@dxos/ui-types';
+import { type ComplexMap, type Position } from '@dxos/util';
+
+import { meta } from '../meta';
+
+import { type ObjectViewerProps, type SpaceSettingsProps } from './types';
+
+export namespace SpaceCapabilities {
+  export const Settings = Capability.make<Atom.Writable<SpaceSettingsProps>>(`${meta.id}.capability.settings`);
+
+  /** Schema for persisted space plugin state. */
+  export const StateSchema = Schema.mutable(
+    Schema.Struct({
+      spaceNames: Schema.Record({ key: Schema.String, value: Schema.String }),
+      enabledEdgeReplication: Schema.Boolean,
+    }),
+  );
+
+  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`);
+
+  /** Ephemeral space plugin state (not persisted). */
+  export type SpaceEphemeralState = {
+    awaiting: string | undefined;
+    sdkMigrationRunning: Record<string, boolean>;
+    navigableCollections: boolean;
+    viewersByObject: Record<string, ComplexMap<PublicKey, ObjectViewerProps>>;
+    viewersByIdentity: ComplexMap<PublicKey, Set<string>>;
+  };
+
+  /** Transient/ephemeral state (not persisted). */
+  export const EphemeralState = Capability.make<Atom.Writable<SpaceEphemeralState>>(
+    `${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 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 type OnSchemaAdded = (params: {
+    db: Database.Database;
+    schema: Schema.Schema.AnyNoContext;
+    // 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`);
+
+  // 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`);
+}

package/src/types/events.ts

@@ -0,0 +1,16 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { ActivationEvent } from '@dxos/app-framework';
+import { AppActivationEvents } from '@dxos/app-toolkit';
+
+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`);
+}

package/src/types/form.ts

@@ -0,0 +1,62 @@
+//
+// 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')),
+});
+
+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 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;
+          })
+          .map((schema) => Type.getTypename(schema))
+      : [];
+
+  const databaseTypenames =
+    includeDatabase && space
+      ? space.db.schemaRegistry
+          .query({ location: ['database'] })
+          .runSync()
+          .map((schema) => Type.getTypename(schema))
+      : [];
+
+  return Array.from(new Set<string>([...runtimeTypenames, ...databaseTypenames])).sort();
+};

package/src/types/index.ts

@@ -2,4 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
+export * from './capabilities';
+export * from './events';
+export * from './form';
 export * from './types';