@dxos/app-framework 0.8.4-main.ae835ea → 0.8.4-main.bc674ce

package/src/plugin-intent/intent.ts

@@ -1,154 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-export type IntentParams = {
-  readonly input: Schema.Schema.All;
-  readonly output: Schema.Schema.All;
-};
-
-export type IntentData<Fields extends IntentParams> =
-  Schema.Schema.Type<Schema.Struct<Fields>> extends { readonly input: any }
-    ? Schema.Schema.Type<Schema.Struct<Fields>>['input']
-    : any;
-
-export type IntentResultData<Fields extends IntentParams> =
-  Schema.Schema.Type<Schema.Struct<Fields>> extends { readonly output: any }
-    ? Schema.Schema.Type<Schema.Struct<Fields>>['output']
-    : any;
-
-export type IntentSchema<Tag extends string, Fields extends IntentParams> = Schema.TaggedClass<any, Tag, Fields>;
-
-/**
- * An intent is an abstract description of an operation to be performed.
- * Intents allow actions to be performed across plugins.
- */
-export type Intent<Tag extends string, Fields extends IntentParams> = {
-  _schema: IntentSchema<Tag, Fields>;
-
-  /**
-   * The id of the intent.
-   */
-  id: Tag;
-
-  /**
-   * Any data needed to perform the desired action.
-   */
-  data: IntentData<Fields>;
-
-  /**
-   * Whether or not the intent is being undone.
-   */
-  undo?: boolean;
-};
-
-export type AnyIntent = Intent<any, any>;
-
-/**
- * Chain of intents to be executed together.
- * The result of each intent is merged into the next intent's input data.
- */
-export type IntentChain<
-  FirstTag extends string,
-  LastTag extends string,
-  FirstFields extends IntentParams,
-  LastFields extends IntentParams,
-> = {
-  first: Intent<FirstTag, FirstFields>;
-  last: Intent<LastTag, LastFields>;
-  all: AnyIntent[];
-};
-
-export type AnyIntentChain = IntentChain<any, any, any, any>;
-
-/**
- * Creates a typed intent.
- * @param schema Schema of the intent. Must be a tagged class with input and output schemas.
- * @param data Data fulfilling the input schema of the intent.
- * @param params.plugin Optional plugin ID to send the intent to.
- * @param params.undo Optional flag to indicate that the intent is being undone. Generally not set manually.
- */
-export const createIntent = <Tag extends string, Fields extends IntentParams>(
-  schema: IntentSchema<Tag, Fields>,
-  data: IntentData<Fields> = {},
-  params: Pick<AnyIntent, 'undo'> = {},
-): IntentChain<Tag, Tag, Fields, Fields> => {
-  // The output of validateSync breaks proxy objects so this is just used for validation.
-  // TODO(wittjosiah): Is there a better way to make theses types align?
-  const _ = Schema.validateSync(schema.fields.input as Schema.Schema<any, any, unknown>)(data);
-  const intent = {
-    ...params,
-    _schema: schema,
-    id: schema._tag,
-    data,
-  } satisfies Intent<Tag, Fields>;
-
-  return {
-    first: intent,
-    last: intent,
-    all: [intent],
-  };
-};
-
-// TODO(wittjosiah): Add a function for mapping the output of one intent to the input of another.
-
-/**
- * Chain two intents together.
- *
- * NOTE: Chaining of intents depends on the data inputs and outputs being structs.
- */
-export const chain =
-  <
-    FirstTag extends string,
-    NextTag extends string,
-    FirstFields extends IntentParams,
-    LastFields extends IntentParams,
-    NextFields extends IntentParams,
-  >(
-    schema: IntentSchema<NextTag, NextFields>,
-    data: Omit<IntentData<NextFields>, keyof IntentResultData<LastFields>> = {},
-    params: Pick<AnyIntent, 'undo'> = {},
-  ) =>
-  (
-    intent: IntentChain<FirstTag, any, FirstFields, LastFields>,
-  ): IntentChain<FirstTag, NextTag, FirstFields, NextFields> => {
-    const intents = 'all' in intent ? intent.all : [intent];
-    const first = intents[0];
-    const last = {
-      ...params,
-      _schema: schema,
-      id: schema._tag,
-      data,
-    } satisfies Intent<NextTag, NextFields>;
-
-    return {
-      first,
-      last,
-      all: [...intents, last],
-    };
-  };
-
-//
-// Intents
-//
-
-// NOTE: Should maintain compatibility with `i18next` (and @dxos/react-ui).
-// TODO(wittjosiah): Making this immutable breaks type compatibility.
-export const Label = Schema.Union(
-  Schema.String,
-  Schema.mutable(
-    Schema.Tuple(
-      Schema.String,
-      Schema.mutable(
-        Schema.Struct({
-          ns: Schema.String,
-          count: Schema.optional(Schema.Number),
-          defaultValue: Schema.optional(Schema.String),
-        }),
-      ),
-    ),
-  ),
-);
-export type Label = Schema.Schema.Type<typeof Label>;

package/src/plugin-intent/meta.ts

@@ -1,10 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type PluginMeta } from '@dxos/app-framework';
-
-export const meta: PluginMeta = {
-  id: 'dxos.org/plugin/intent',
-  name: 'Intent',
-};

package/src/plugin-settings/intent-resolver.ts

@@ -1,35 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Function from 'effect/Function';
-
-import { Capabilities, LayoutAction } from '../common';
-import { contributes } from '../core';
-import { chain, createIntent, createResolver } from '../plugin-intent';
-
-import { SETTINGS_ID, SETTINGS_KEY, SettingsAction } from './actions';
-
-export default () =>
-  contributes(
-    Capabilities.IntentResolver,
-    createResolver({
-      intent: SettingsAction.Open,
-      resolve: ({ plugin }) => {
-        const openSettings = createIntent(LayoutAction.SwitchWorkspace, { part: 'workspace', subject: SETTINGS_ID });
-        return {
-          intents: [
-            plugin
-              ? Function.pipe(
-                  openSettings,
-                  chain(LayoutAction.Open, {
-                    part: 'main',
-                    subject: [`${SETTINGS_KEY}:${plugin.replaceAll('/', ':')}`],
-                  }),
-                )
-              : openSettings,
-          ],
-        };
-      },
-    }),
-  );

package/src/plugin-settings/store.ts

@@ -1,33 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { RootSettingsStore } from '@dxos/local-storage';
-
-import { Capabilities } from '../common';
-import { type PluginContext, contributes } from '../core';
-
-export default (context: PluginContext) => {
-  // TODO(wittjosiah): Replace with rx?
-  const settingsStore = new RootSettingsStore();
-
-  let previous: Capabilities.Settings[] = [];
-  const registry = context.getCapability(Capabilities.RxRegistry);
-  const cancel = registry.subscribe(
-    context.capabilities(Capabilities.Settings),
-    (allSettings) => {
-      const added = allSettings.filter((setting) => !previous.includes(setting));
-      const removed = previous.filter((setting) => !allSettings.includes(setting));
-      previous = allSettings;
-      added.forEach((setting) => {
-        settingsStore.createStore(setting as any);
-      });
-      removed.forEach((setting) => {
-        settingsStore.removeStore(setting.prefix);
-      });
-    },
-    { immediate: true },
-  );
-
-  return contributes(Capabilities.SettingsStore, settingsStore, () => cancel());
-};

package/src/react/IntentContext.tsx

@@ -1,35 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Context, type Provider, createContext, useContext, useEffect } from 'react';
-
-import { raise } from '@dxos/debug';
-import { pick } from '@dxos/util';
-
-import { Capabilities } from '../common';
-import { type AnyIntentResolver, type IntentContext } from '../plugin-intent';
-
-import { usePluginManager } from './PluginManagerProvider';
-
-const IntentContext: Context<IntentContext | undefined> = createContext<IntentContext | undefined>(undefined);
-
-export const useIntentDispatcher = (): Pick<IntentContext, 'dispatch' | 'dispatchPromise'> => {
-  const context = useContext(IntentContext) ?? raise(new Error('IntentContext not found'));
-  return pick(context, ['dispatch', 'dispatchPromise']);
-};
-
-export const useIntentResolver = (module: string, resolver: AnyIntentResolver) => {
-  const manager = usePluginManager();
-  useEffect(() => {
-    manager.context.contributeCapability({
-      module,
-      interface: Capabilities.IntentResolver,
-      implementation: resolver,
-    });
-
-    return () => manager.context.removeCapability(Capabilities.IntentResolver, resolver);
-  }, [module, resolver]);
-};
-
-export const IntentProvider: Provider<IntentContext | undefined> = IntentContext.Provider;

package/src/react/useIntentResolver.ts

@@ -1,22 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { useEffect } from 'react';
-
-import { Capabilities } from '../common';
-import { type AnyIntentResolver } from '../plugin-intent';
-import { usePluginManager } from '../react';
-
-export const useIntentResolver = (module: string, resolver: AnyIntentResolver) => {
-  const manager = usePluginManager();
-  useEffect(() => {
-    manager.context.contributeCapability({
-      module,
-      interface: Capabilities.IntentResolver,
-      implementation: resolver,
-    });
-
-    return () => manager.context.removeCapability(Capabilities.IntentResolver, resolver);
-  }, [module, resolver]);
-};

package/src/worker.ts

@@ -1,11 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-// Entrypoint for using plugins in workers runtimes (e.g. Cloudflare Workers, etc.)
-// Excludes all frontend code & dependencies (e.g. localStorage, React, etc.)
-
-export * from './core';
-// NOTE: Common includes browser capabilities but they are types only.
-export * from './common';
-export * from './plugin-intent';