@dxos/app-framework 0.6.12-main.15a606f → 0.6.12-main.2d19bf1

package/src/plugins/PluginHost/plugin.ts

@@ -20,54 +20,56 @@ export type PluginProvides<TProvides> = TProvides & {
   root?: FC<PropsWithChildren>;
 };
 
+export type PluginMeta = {
+  /**
+   * Globally unique ID.
+   *
+   * Expected to be in the form of a valid URL.
+   *
+   * @example dxos.org/plugin/example
+   */
+  id: string;
+
+  /**
+   * Short ID for use in URLs.
+   *
+   * NOTE: This is especially experimental and likely to change.
+   */
+  // TODO(wittjosiah): How should these be managed?
+  shortId?: string;
+
+  /**
+   * Human-readable name.
+   */
+  name?: string;
+
+  /**
+   * Short description of plugin functionality.
+   */
+  description?: string;
+
+  /**
+   * URL of home page.
+   */
+  homePage?: string;
+
+  /**
+   * Tags to help categorize the plugin.
+   */
+  tags?: string[];
+
+  /**
+   * A grep-able symbol string which can be resolved to an icon asset by @ch-ui/icons, via @ch-ui/vite-plugin-icons.
+   */
+  icon?: string;
+};
+
 /**
  * A unit of containment of modular functionality that can be provided to an application.
  * Plugins provide things like components, state, actions, etc. to the application.
  */
 export type Plugin<TProvides = {}> = {
-  meta: {
-    /**
-     * Globally unique ID.
-     *
-     * Expected to be in the form of a valid URL.
-     *
-     * @example dxos.org/plugin/example
-     */
-    id: string;
-
-    /**
-     * Short ID for use in URLs.
-     *
-     * NOTE: This is especially experimental and likely to change.
-     */
-    // TODO(wittjosiah): How should these be managed?
-    shortId?: string;
-
-    /**
-     * Human-readable name.
-     */
-    name?: string;
-
-    /**
-     * Short description of plugin functionality.
-     */
-    description?: string;
-
-    /**
-     * URL of home page.
-     */
-    homePage?: string;
-
-    /**
-     * Tags to help categorize the plugin.
-     */
-    tags?: string[];
-
-    /**
-     * A grep-able symbol string which can be resolved to an icon asset by @ch-ui/icons, via @ch-ui/vite-plugin-icons.
-     */
-    icon?: string;
-  };
+  meta: PluginMeta;
 
   /**
    * Capabilities provided by the plugin.
@@ -107,8 +109,6 @@ export type PluginDefinition<TProvides = {}, TInitializeProvides = {}> = Omit<Pl
   unload?: () => Promise<void>;
 };
 
-export const pluginMeta = (meta: Plugin['meta']) => meta;
-
 type LazyPlugin<T> = () => Promise<{ default: (props: T) => PluginDefinition }>;
 
 export namespace Plugin {

package/src/plugins/common/navigation.ts

@@ -2,10 +2,9 @@
 // Copyright 2024 DXOS.org
 //
 
+import { Schema as S } from '@effect/schema';
 import { z } from 'zod';
 
-import { S } from '@dxos/echo-schema';
-
 import type { IntentData } from '../IntentPlugin';
 import type { Plugin } from '../PluginHost';
 
@@ -30,7 +29,9 @@ const LayoutPartSchema = S.Union(
 );
 export type LayoutPart = S.Schema.Type<typeof LayoutPartSchema>;
 
-const LayoutPartsSchema = S.partial(S.mutable(S.Record(LayoutPartSchema, S.mutable(S.Array(LayoutEntrySchema)))));
+const LayoutPartsSchema = S.partial(
+  S.mutable(S.Record({ key: LayoutPartSchema, value: S.mutable(S.Array(LayoutEntrySchema)) })),
+);
 export type LayoutParts = S.Schema.Type<typeof LayoutPartsSchema>;
 
 const LayoutCoordinateSchema = S.mutable(S.Struct({ part: LayoutPartSchema, entryId: S.String }));
@@ -51,14 +52,6 @@ export type ActiveParts = z.infer<typeof ActiveParts>;
 // TODO(burdon): Where should this go?
 export type LayoutContainerProps<T> = T & { role?: string; coordinate?: LayoutCoordinate };
 
-/**
- * Basic state provided by a navigation plugin.
- */
-export const Attention = z.object({
-  attended: z.set(z.string()).describe('Ids of items which have focus.'),
-});
-export type Attention = z.infer<typeof Attention>;
-
 /**
  * Provides for a plugin that can manage the app navigation.
  */

package/tsconfig.json

@@ -16,35 +16,7 @@
   "include": [
     "src"
   ],
-  "references": [
-    {
-      "path": "../../common/async"
-    },
-    {
-      "path": "../../common/debug"
-    },
-    {
-      "path": "../../common/invariant"
-    },
-    {
-      "path": "../../common/local-storage"
-    },
-    {
-      "path": "../../common/log"
-    },
-    {
-      "path": "../../common/util"
-    },
-    {
-      "path": "../../core/echo/echo-schema"
-    },
-    {
-      "path": "../app-graph"
-    },
-    {
-      "path": "../client-protocol"
-    }
-  ],
+  "references": [],
   "ts-node": {
     "compilerOptions": {
       "module": "CommonJS"

package/vitest.config.ts

@@ -6,4 +6,4 @@ import { defineConfig, mergeConfig } from 'vitest/config';
 
 import { baseConfig } from '../../../vitest.shared';
 
-export default mergeConfig(baseConfig(), defineConfig({}));
+export default mergeConfig(baseConfig({ cwd: __dirname }), defineConfig({}));