@dxos/app-framework 0.8.2-main.f11618f → 0.8.2-staging.7ac8446

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/app-framework",
-  "version": "0.8.2-main.f11618f",
+  "version": "0.8.2-staging.7ac8446",
   "description": "A framework for building applications from composible plugins.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -38,30 +38,29 @@
   },
   "dependencies": {
     "@preact/signals-core": "^1.6.0",
-    "@dxos/app-graph": "0.8.2-main.f11618f",
-    "@dxos/artifact": "0.8.2-main.f11618f",
-    "@dxos/async": "0.8.2-main.f11618f",
-    "@dxos/client-protocol": "0.8.2-main.f11618f",
-    "@dxos/echo-schema": "0.8.2-main.f11618f",
-    "@dxos/invariant": "0.8.2-main.f11618f",
-    "@dxos/local-storage": "0.8.2-main.f11618f",
-    "@dxos/live-object": "0.8.2-main.f11618f",
-    "@dxos/log": "0.8.2-main.f11618f",
-    "@dxos/debug": "0.8.2-main.f11618f",
-    "@dxos/react-hooks": "0.8.2-main.f11618f",
-    "@dxos/util": "0.8.2-main.f11618f"
+    "@dxos/app-graph": "0.8.2-staging.7ac8446",
+    "@dxos/async": "0.8.2-staging.7ac8446",
+    "@dxos/debug": "0.8.2-staging.7ac8446",
+    "@dxos/artifact": "0.8.2-staging.7ac8446",
+    "@dxos/client-protocol": "0.8.2-staging.7ac8446",
+    "@dxos/invariant": "0.8.2-staging.7ac8446",
+    "@dxos/live-object": "0.8.2-staging.7ac8446",
+    "@dxos/local-storage": "0.8.2-staging.7ac8446",
+    "@dxos/log": "0.8.2-staging.7ac8446",
+    "@dxos/util": "0.8.2-staging.7ac8446",
+    "@dxos/react-hooks": "0.8.2-staging.7ac8446"
   },
   "devDependencies": {
     "@phosphor-icons/react": "^2.1.5",
     "@types/react": "~18.2.0",
     "effect": "3.13.3",
     "react": "~18.2.0",
-    "typedoc": "0.28.1",
-    "@dxos/echo-signals": "0.8.2-main.f11618f",
-    "@dxos/random": "0.8.2-main.f11618f",
-    "@dxos/react-ui": "0.8.2-main.f11618f",
-    "@dxos/react-ui-syntax-highlighter": "0.8.2-main.f11618f",
-    "@dxos/storybook-utils": "0.8.2-main.f11618f"
+    "@dxos/echo-schema": "0.8.2-staging.7ac8446",
+    "@dxos/echo-signals": "0.8.2-staging.7ac8446",
+    "@dxos/random": "0.8.2-staging.7ac8446",
+    "@dxos/react-ui": "0.8.2-staging.7ac8446",
+    "@dxos/react-ui-syntax-highlighter": "0.8.2-staging.7ac8446",
+    "@dxos/storybook-utils": "0.8.2-staging.7ac8446"
   },
   "peerDependencies": {
     "effect": "3.13.3",
@@ -69,8 +68,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "scripts": {
-    "typedoc": "typedoc --out typedoc"
   }
 }

package/project.json

@@ -19,8 +19,7 @@
     },
     "lint": {},
     "pack": {},
-    "test": {},
-    "typedoc": {}
+    "test": {}
   },
   "implicitDependencies": [
     "esbuild"

package/src/App.tsx

@@ -6,7 +6,7 @@ import { effect } from '@preact/signals-core';
 import React, { useEffect, useState, type FC, type PropsWithChildren } from 'react';
 
 import { invariant } from '@dxos/invariant';
-import { live } from '@dxos/live-object';
+import { create } from '@dxos/live-object';
 
 import { Capabilities, Events } from './common';
 import { PluginManager, type PluginManagerOptions, type Plugin } from './core';
@@ -69,7 +69,7 @@ export const createApp = ({
       return plugin;
     });
 
-  const state = live({ ready: false, error: null });
+  const state = create({ ready: false, error: null });
   const cached: string[] = JSON.parse(localStorage.getItem(ENABLED_KEY) ?? '[]');
   const enabled = cacheEnabled && cached.length > 0 ? cached : defaults;
   const manager = pluginManager ?? new PluginManager({ pluginLoader, plugins, core, enabled });

package/src/common/index.ts

@@ -3,7 +3,6 @@
 //
 
 export * from './capabilities';
-export * from './collaboration';
 export * from './events';
 export * from './file';
 export * from './graph';

package/src/common/layout.ts

@@ -108,12 +108,9 @@ export namespace LayoutAction {
   export class UpdatePopover extends S.TaggedClass<UpdatePopover>()(UPDATE_LAYOUT, {
     input: S.Struct({
       part: S.Literal('popover').annotations({ description: 'Updating the popover.' }),
-      subject: S.optional(
-        S.Any.annotations({
-          description: 'URI of the component to display in the popover or data to pass to the popover.',
-        }),
-      ),
+      subject: S.optional(S.String.annotations({ description: 'URI of the component to display in the popover.' })),
       options: S.Struct({
+        anchorId: S.String.annotations({ description: 'The id of the element to anchor the popover to.' }),
         side: S.optional(
           S.Literal('top', 'right', 'bottom', 'left').annotations({ description: 'The side of the anchor.' }),
         ),
@@ -123,22 +120,7 @@ export namespace LayoutAction {
             description: 'Additional props for the popover.',
           }),
         ),
-      }).pipe(
-        S.extend(
-          S.Union(
-            S.Struct({
-              variant: S.Literal('virtual'),
-              anchor: S.Any.annotations({ description: 'The DOM element to anchor the popover to.' }),
-            }),
-            S.Struct({
-              variant: S.optional(S.Literal('react')),
-              anchorId: S.String.annotations({
-                description: 'An id that can be used to determine whether to render the anchor subcomponent.',
-              }),
-            }),
-          ),
-        ),
-      ),
+      }),
     }),
     output: S.Void,
   }) {}
@@ -198,7 +180,6 @@ export namespace LayoutAction {
           key: S.optional(
             S.String.annotations({ description: 'If provided, will replace item with a matching key (id prefix).' }),
           ),
-          workspace: S.optional(S.String.annotations({ description: 'The workspace to open the items in.' })),
           scrollIntoView: S.optional(S.Boolean.annotations({ description: 'Scroll the items into view.' })),
           pivotId: S.optional(S.String.annotations({ description: 'The id of the item to place new items next to.' })),
           positioning: S.optional(

package/src/core/capabilities.ts

@@ -10,7 +10,7 @@ import { Effect } from 'effect';
 
 import { Trigger } from '@dxos/async';
 import { invariant } from '@dxos/invariant';
-import { live } from '@dxos/live-object';
+import { create } from '@dxos/live-object';
 import { log } from '@dxos/log';
 import { type MaybePromise } from '@dxos/util';
 
@@ -34,8 +34,7 @@ export const defineCapability = <T>(identifier: string) => {
 };
 
 /**
- * A unique string identifier with a Typescript type associated with it.
- * When a capability is contributed to the application an implementation of the interface is provided.
+ * Functionality contributed to the application by a plugin module.
  */
 export type Capability<T> = {
   /**
@@ -96,11 +95,8 @@ export const lazy =
   };
 
 /**
- * Facilitates the dependency injection between [plugin modules](#pluginmodule) by allowing them contribute and request capabilities from each other.
- * It tracks the capabilities that are contributed in an in-memory live object.
- * This allows the application to subscribe to this state and incorporate plugins which are added dynamically.
+ * Context which is passed to plugins, allowing them to interact with each other.
  */
-// TOOD(burdon): Rename PluginContext.
 export class PluginsContext {
   private readonly _definedCapabilities = new Map<string, CapabilityImpl<unknown>[]>();
 
@@ -137,7 +133,7 @@ export class PluginsContext {
   }) {
     let current = this._definedCapabilities.get(interfaceDef.identifier);
     if (!current) {
-      const object = live<{ value: CapabilityImpl<unknown>[] }>({ value: [] });
+      const object = create<{ value: CapabilityImpl<unknown>[] }>({ value: [] });
       current = untracked(() => object.value);
       this._definedCapabilities.set(interfaceDef.identifier, current);
     }
@@ -179,7 +175,7 @@ export class PluginsContext {
   ): U[] {
     let current = this._definedCapabilities.get(interfaceDef.identifier);
     if (!current) {
-      const object = live<{ value: CapabilityImpl<unknown>[] }>({ value: [] });
+      const object = create<{ value: CapabilityImpl<unknown>[] }>({ value: [] });
       current = untracked(() => object.value);
       this._definedCapabilities.set(interfaceDef.identifier, current);
     }

package/src/core/events.ts

@@ -3,10 +3,7 @@
 //
 
 /**
- * A unique string identifier representing an event.
- * This is expected to be a URI, where initial parts are often the id of the plugin whose package defines the event.
- *
- * @example dxos.org/plugin/example/event/ready
+ * An event which activates a plugin module.
  */
 export type ActivationEvent = {
   id: string;

package/src/core/manager.test.ts

@@ -11,7 +11,7 @@ import { raise } from '@dxos/debug';
 import { updateCounter } from '@dxos/echo-schema/testing';
 import { registerSignalsRuntime } from '@dxos/echo-signals';
 import { invariant } from '@dxos/invariant';
-import { live } from '@dxos/live-object';
+import { create } from '@dxos/live-object';
 
 import { contributes, defineCapability, type PluginsContext } from './capabilities';
 import { allOf, defineEvent, oneOf } from './events';
@@ -358,14 +358,14 @@ describe('PluginManager', () => {
         id,
         activatesOn: Events.Startup,
         activatesAfter: [stateEvent],
-        activate: () => contributes(Number, live({ number: 1 })),
+        activate: () => contributes(Number, create({ number: 1 })),
       }),
       defineModule({
         id: 'dxos.org/test/doubler',
         activatesOn: stateEvent,
         activate: (context) => {
           const counter = context.requestCapability(Number);
-          const state = live({ total: counter.number * 2 });
+          const state = create({ total: counter.number * 2 });
           const unsubscribe = effect(() => {
             state.total = counter.number * 2;
           });

package/src/core/manager.ts

@@ -6,7 +6,7 @@ import { untracked } from '@preact/signals-core';
 import { Array as A, Effect, Either, Match, pipe } from 'effect';
 
 import { Event } from '@dxos/async';
-import { live, type Live } from '@dxos/live-object';
+import { create, type ReactiveObject } from '@dxos/live-object';
 import { log } from '@dxos/log';
 import { type MaybePromise } from '@dxos/util';
 
@@ -49,7 +49,7 @@ export class PluginManager {
     reset: (id) => this._reset(id),
   });
 
-  private readonly _state: Live<PluginManagerState>;
+  private readonly _state: ReactiveObject<PluginManagerState>;
   private readonly _pluginLoader: PluginManagerOptions['pluginLoader'];
   private readonly _capabilities = new Map<string, AnyCapability[]>();
 
@@ -60,7 +60,7 @@ export class PluginManager {
     enabled = [],
   }: PluginManagerOptions) {
     this._pluginLoader = pluginLoader;
-    this._state = live({
+    this._state = create({
       plugins,
       core,
       enabled,
@@ -79,7 +79,7 @@ export class PluginManager {
    *
    * @reactive
    */
-  get plugins(): Live<readonly Plugin[]> {
+  get plugins(): ReactiveObject<readonly Plugin[]> {
     return this._state.plugins;
   }
 
@@ -88,7 +88,7 @@ export class PluginManager {
    *
    * @reactive
    */
-  get core(): Live<readonly string[]> {
+  get core(): ReactiveObject<readonly string[]> {
     return this._state.core;
   }
 
@@ -97,7 +97,7 @@ export class PluginManager {
    *
    * @reactive
    */
-  get enabled(): Live<readonly string[]> {
+  get enabled(): ReactiveObject<readonly string[]> {
     return this._state.enabled;
   }
 
@@ -106,7 +106,7 @@ export class PluginManager {
    *
    * @reactive
    */
-  get modules(): Live<readonly PluginModule[]> {
+  get modules(): ReactiveObject<readonly PluginModule[]> {
     return this._state.modules;
   }
 
@@ -115,7 +115,7 @@ export class PluginManager {
    *
    * @reactive
    */
-  get active(): Live<readonly string[]> {
+  get active(): ReactiveObject<readonly string[]> {
     return this._state.active;
   }
 
@@ -124,7 +124,7 @@ export class PluginManager {
    *
    * @reactive
    */
-  get eventsFired(): Live<readonly string[]> {
+  get eventsFired(): ReactiveObject<readonly string[]> {
     return this._state.eventsFired;
   }
 
@@ -133,7 +133,7 @@ export class PluginManager {
    *
    * @reactive
    */
-  get pendingReset(): Live<readonly string[]> {
+  get pendingReset(): ReactiveObject<readonly string[]> {
     return this._state.pendingReset;
   }
 

package/src/core/plugin.ts

@@ -42,7 +42,7 @@ interface PluginModuleInterface {
 
 /**
  * A unit of containment of modular functionality that can be provided to an application.
- * Activation of a module is async allowing for code to split and loaded lazily.
+ * Plugins provide things like components, state, actions, etc. to the application.
  */
 // NOTE: This is implemented as a class to prevent it from being proxied by PluginManager state.
 export class PluginModule implements PluginModuleInterface {
@@ -114,7 +114,6 @@ export type PluginMeta = {
 
 /**
  * A collection of modules that are be enabled/disabled as a unit.
- * Plugins provide things such as components, state, actions, etc. to the application.
  */
 // NOTE: This is implemented as a class to prevent it from being proxied by PluginManager state.
 export class Plugin {

package/src/plugin-intent/intent-dispatcher.ts

@@ -5,7 +5,7 @@
 import { Effect, Option, pipe, Ref } from 'effect';
 import { type Simplify } from 'effect/Types';
 
-import { live } from '@dxos/live-object';
+import { create } from '@dxos/live-object';
 import { log } from '@dxos/log';
 import { byPosition, type MaybePromise, type Position, type GuardedType } from '@dxos/util';
 
@@ -91,25 +91,9 @@ export type IntentEffectDefinition<Input, Output> = (
  * Intent resolver to match intents to their effects.
  */
 export type IntentResolver<Tag extends string, Fields extends IntentParams, Data = IntentData<Fields>> = Readonly<{
-  /**
-   * The schema of the intent to be resolved.
-   */
   intent: IntentSchema<Tag, Fields>;
-
-  /**
-   * Hint to determine the order the resolvers are processed if multiple resolvers are defined for the same intent.
-   * Only one resolver will be used.
-   */
   position?: Position;
-
-  /**
-   * Optional filter to determine if the resolver should be used.
-   */
   filter?: (data: IntentData<Fields>) => data is Data;
-
-  /**
-   * The effect to be performed when the intent is resolved.
-   */
   resolve: IntentEffectDefinition<GuardedType<IntentResolver<Tag, Fields, Data>['filter']>, IntentResultData<Fields>>;
 }>;
 
@@ -303,7 +287,7 @@ const defaultEffect = () => Effect.fail(new Error('Intent runtime not ready'));
 const defaultPromise = () => Effect.runPromise(defaultEffect());
 
 export default (context: PluginsContext) => {
-  const state = live<IntentContext>({
+  const state = create<IntentContext>({
     dispatch: defaultEffect,
     dispatchPromise: defaultPromise,
     undo: defaultEffect,