@dxos/app-framework 0.8.4-main.f5c0578 → 0.8.4-main.fcfe5033a5

package/dist/types/src/ui/hooks/useApp.d.ts

@@ -0,0 +1,62 @@
+import React, { type FC } from 'react';
+import { type FallbackProps } from '@dxos/react-error-boundary';
+import { type ActivationEvent, type Plugin, PluginManager } from '../../core';
+export type StartupProgress = {
+    /** Number of modules that have been activated. */
+    activated: number;
+    /** Total number of modules registered. */
+    total: number;
+    /** Fractional progress (0-1). */
+    progress: number;
+    /** Human-readable label for the currently activating module. */
+    status?: string;
+};
+export type PlaceholderProps = {
+    stage?: number;
+    progress?: StartupProgress;
+};
+export type UseAppOptions = {
+    pluginManager?: PluginManager.PluginManager;
+    pluginLoader?: PluginManager.ManagerOptions['pluginLoader'];
+    plugins?: Plugin.Plugin[];
+    core?: string[];
+    defaults?: string[];
+    /**
+     * Additional activation events to fire before startup.
+     * These are fired alongside SetupReactSurface before the Startup event.
+     */
+    setupEvents?: ActivationEvent.ActivationEvent[];
+    cacheEnabled?: boolean;
+    safeMode?: boolean;
+    debounce?: number;
+    timeout?: number;
+    fallback?: FC<FallbackProps>;
+    placeholder?: FC<PlaceholderProps>;
+};
+/**
+ * Expected usage is for this to be the entrypoint of the application.
+ * Initializes plugins and renders the root components.
+ *
+ * @example
+ * const plugins = [LayoutPlugin(), MyPlugin()];
+ * const core = [LayoutPluginId];
+ * const default = [MyPluginId];
+ * const fallback = <div>Initializing Plugins...</div>;
+ * const App = useApp({ plugins, core, default, fallback });
+ * createRoot(document.getElementById('root')!).render(
+ *   <StrictMode>
+ *     <App />
+ *   </StrictMode>,
+ * );
+ *
+ * @param params.pluginLoader A function which loads new plugins.
+ * @param params.plugins All plugins available to the application.
+ * @param params.core Core plugins which will always be enabled.
+ * @param params.defaults Default plugins are enabled by default but can be disabled by the user.
+ * @param params.cacheEnabled Whether to cache enabled plugins in localStorage.
+ * @param params.safeMode Whether to enable safe mode, which disables optional plugins.
+ * @param params.fallback Fallback component to render if an error occurs during startup.
+ * @param params.placeholder Placeholder component to render during startup.
+ */
+export declare const useApp: ({ pluginManager, pluginLoader: pluginLoaderProp, plugins: pluginsProp, core: coreProp, defaults: defaultsProp, setupEvents: setupEventsProp, placeholder, fallback, cacheEnabled, safeMode, debounce, timeout, }: UseAppOptions) => () => React.JSX.Element;
+//# sourceMappingURL=useApp.d.ts.map

package/dist/types/src/ui/hooks/useApp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useApp.d.ts","sourceRoot":"","sources":["../../../../../src/ui/hooks/useApp.tsx"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,EAAE,KAAK,EAAE,EAAqD,MAAM,OAAO,CAAC;AAK1F,OAAO,EAAgC,KAAK,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAM9F,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,MAAM,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK9E,MAAM,MAAM,eAAe,GAAG;IAC5B,kDAAkD;IAClD,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC;IAC5C,YAAY,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC,eAAe,EAAE,CAAC;IAChD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC;IAC7B,WAAW,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,MAAM,GAAI,kNAapB,aAAa,4BAoKf,CAAC"}

package/dist/types/src/ui/hooks/useApp.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useApp.test.d.ts.map

package/dist/types/src/ui/hooks/useApp.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useApp.test.d.ts","sourceRoot":"","sources":["../../../../../src/ui/hooks/useApp.test.tsx"],"names":[],"mappings":""}

package/dist/types/src/ui/hooks/useCapabilities.d.ts

@@ -0,0 +1,31 @@
+import { type Atom } from '@effect-atom/atom-react';
+import { Capabilities } from '../../common';
+import { type Capability } from '../../core';
+/**
+ * Hook to request capabilities from the plugin context.
+ * @returns An array of capabilities.
+ */
+export declare const useCapabilities: <T>(interfaceDef: Capability.InterfaceDef<T>) => T[];
+/**
+ * Hook to request a capability from the plugin context.
+ * @returns The capability.
+ * @throws If no capability is found.
+ */
+export declare const useCapability: <T>(interfaceDef: Capability.InterfaceDef<T>) => T;
+/**
+ * Hook to get the current value of an atom capability.
+ * Automatically subscribes to changes.
+ * @example const settings = useAtomCapability(ThreadCapabilities.Settings);
+ */
+export declare const useAtomCapability: <T>(atomCapability: Capability.InterfaceDef<Atom.Atom<T>>) => T;
+/**
+ * Hook to get value and updater for an atom capability.
+ * Returns [currentValue, updateFn] similar to useState.
+ * @example const [settings, updateSettings] = useAtomCapabilityState(ThreadCapabilities.Settings);
+ */
+export declare const useAtomCapabilityState: <T>(atomCapability: Capability.InterfaceDef<Atom.Writable<T>>) => [T, (fn: (current: T) => T) => void];
+/**
+ * Hook to get the operation invoker capability.
+ */
+export declare const useOperationInvoker: () => Capabilities.OperationInvoker;
+//# sourceMappingURL=useCapabilities.d.ts.map

package/dist/types/src/ui/hooks/useCapabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCapabilities.d.ts","sourceRoot":"","sources":["../../../../../src/ui/hooks/useCapabilities.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,IAAI,EAAgB,MAAM,yBAAyB,CAAC;AAKlE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7C;;;GAGG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,EAAE,cAAc,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,QAG1E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,EAAE,cAAc,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,MAIxE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,EAAE,gBAAgB,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAG,CAG5F,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAI,CAAC,EACtC,gBAAgB,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KACxD,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,KAAK,IAAI,CAWrC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,QAAO,YAAY,CAAC,gBAAgE,CAAC"}

package/dist/types/src/ui/hooks/useLoading.d.ts

@@ -0,0 +1,18 @@
+export declare enum LoadingState {
+    Loading = 0,
+    FadeIn = 1,
+    FadeOut = 2,
+    Done = 3
+}
+/**
+ * To avoid "flashing" the placeholder, we wait a period of time before starting the loading animation.
+ * If loading completes during this time the placehoder is not shown, otherwise is it displayed for a minimum period of time.
+ *
+ * States:
+ * 0: Loading   - Wait for a period of time before starting the loading animation.
+ * 1: Fade-in   - Display a loading animation.
+ * 2: Fade-out  - Fade out the loading animation.
+ * 3: Done      - Remove the placeholder.
+ */
+export declare const useLoading: (ready: boolean, debounce?: number) => LoadingState;
+//# sourceMappingURL=useLoading.d.ts.map

package/dist/types/src/ui/hooks/useLoading.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLoading.d.ts","sourceRoot":"","sources":["../../../../../src/ui/hooks/useLoading.tsx"],"names":[],"mappings":"AAMA,oBAAY,YAAY;IACtB,OAAO,IAAI;IACX,MAAM,IAAI;IACV,OAAO,IAAI;IACX,IAAI,IAAI;CACT;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,EAAE,iBAAY,iBA4CtD,CAAC"}

package/dist/types/src/ui/hooks/useSettingsState.d.ts

@@ -0,0 +1,10 @@
+import { type Atom } from '@effect-atom/atom-react';
+/**
+ * Hook to read and update a settings atom.
+ * Returns the current value and an update function.
+ */
+export declare const useSettingsState: <T>(atom: Atom.Writable<T>) => {
+    settings: T;
+    updateSettings: (fn: (current: T) => T) => void;
+};
+//# sourceMappingURL=useSettingsState.d.ts.map

package/dist/types/src/ui/hooks/useSettingsState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSettingsState.d.ts","sourceRoot":"","sources":["../../../../../src/ui/hooks/useSettingsState.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,IAAI,EAAiC,MAAM,yBAAyB,CAAC;AAGnF;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,EAChC,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,KACrB;IAAE,QAAQ,EAAE,CAAC,CAAC;IAAC,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,KAAK,IAAI,CAAA;CAYhE,CAAC"}

package/dist/types/src/ui/hooks/useSurface.d.ts

@@ -0,0 +1,3 @@
+import { Surface } from '../components';
+export declare const useSurface: () => Surface.Context;
+//# sourceMappingURL=useSurface.d.ts.map

package/dist/types/src/ui/hooks/useSurface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSurface.d.ts","sourceRoot":"","sources":["../../../../../src/ui/hooks/useSurface.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,eAAO,MAAM,UAAU,QAAO,OAAO,CAAC,OAErC,CAAC"}

package/dist/types/src/ui/index.d.ts

@@ -0,0 +1,3 @@
+export * from './components';
+export * from './hooks';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/ui/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ui/index.ts"],"names":[],"mappings":"AAIA,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}

package/dist/types/src/vite-plugin/composer-plugin.d.ts

@@ -0,0 +1,34 @@
+import { type Plugin as VitePlugin } from 'vite';
+import { type Plugin } from '../core';
+import { MANIFEST_ASSET_NAME, serializeManifest } from './manifest';
+export { MANIFEST_ASSET_NAME, serializeManifest };
+export type ComposerPluginOptions = {
+    /** Entry point for the plugin bundle. Defaults to `src/plugin.tsx`. */
+    entry?: string;
+    /** Dev server port. Defaults to `3967`. */
+    port?: number;
+    /**
+     * Plugin metadata. When provided, a `manifest.json` asset is emitted alongside the bundle
+     * so the output directory can be uploaded directly as a GitHub Release and picked up by
+     * the DXOS community registry.
+     */
+    meta?: Plugin.Meta;
+    /** Filename of the built module asset that the registry will load. Defaults to `plugin.mjs`. */
+    moduleFile?: string;
+};
+/**
+ * Vite plugin for **external Composer plugin projects**. Configures the build to produce
+ * an ESM bundle that externalizes all framework dependencies, which the Composer host app
+ * provides at runtime via import map.
+ *
+ * Handles:
+ * 1. Build config — lib mode entry point, ES format output, rollup externals.
+ * 2. Dev externalization — marks shared deps as external during `vite serve` and strips
+ *    the `/@id/` prefix that Vite's import analysis adds to external bare specifiers.
+ * 3. JSX dev runtime shim — bridges `react/jsx-dev-runtime` (used by React refresh in dev)
+ *    to `react/jsx-runtime` (which is what the externalized React provides).
+ * 4. Optional manifest emit — when `meta` is supplied, writes `manifest.json` next to the
+ *    bundled module so a GitHub Release can carry both artifacts.
+ */
+export declare const composerPlugin: (options?: ComposerPluginOptions) => VitePlugin[];
+//# sourceMappingURL=composer-plugin.d.ts.map

package/dist/types/src/vite-plugin/composer-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"composer-plugin.d.ts","sourceRoot":"","sources":["../../../../src/vite-plugin/composer-plugin.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,MAAM,IAAI,UAAU,EAAE,MAAM,MAAM,CAAC;AAGjD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAGpE,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,CAAC;AA0DlD,MAAM,MAAM,qBAAqB,GAAG;IAClC,uEAAuE;IACvE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;IACnB,gGAAgG;IAChG,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc,GAAI,UAAU,qBAAqB,KAAG,UAAU,EAyL1E,CAAC"}

package/dist/types/src/vite-plugin/import-map-plugin.d.ts

@@ -0,0 +1,16 @@
+import { type Plugin } from 'vite';
+/**
+ * Vite plugin for the **host app** (Composer). Generates a browser import map so that
+ * shared packages are loaded once and reused by both the host and any remote plugins.
+ *
+ * In dev mode, maps bare specifiers directly to resolved file paths.
+ * In production, emits a dedicated chunk per specifier via virtual wrapper modules,
+ * then injects a `<script type="importmap">` tag into the HTML with the chunk URLs.
+ *
+ * Virtual wrappers are needed because directly emitting chunks for CJS packages loses
+ * their named exports due to Rollup's interop. The wrapper re-exports them explicitly.
+ */
+export declare const importMapPlugin: (options?: {
+    packages?: string[];
+}) => Plugin[];
+//# sourceMappingURL=import-map-plugin.d.ts.map

package/dist/types/src/vite-plugin/import-map-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-map-plugin.d.ts","sourceRoot":"","sources":["../../../../src/vite-plugin/import-map-plugin.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,MAAM,CAAC;AAgUnC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAAI,UAAU;IAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,KAAG,MAAM,EAsJzE,CAAC"}

package/dist/types/src/vite-plugin/index.d.ts

@@ -0,0 +1,4 @@
+export * from './composer-plugin';
+export * from './import-map-plugin';
+export * from './packages';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/vite-plugin/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/vite-plugin/index.ts"],"names":[],"mappings":"AAIA,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC"}

package/dist/types/src/vite-plugin/manifest.d.ts

@@ -0,0 +1,16 @@
+import { type Plugin } from '../core';
+/**
+ * Name of the asset written alongside the built module bundle.
+ * The DXOS community registry resolves each published plugin by fetching this file
+ * from the repo's latest GitHub Release, so authors should not rename it.
+ */
+export declare const MANIFEST_ASSET_NAME = "manifest.json";
+/**
+ * Serializes a plugin's public metadata into the format consumed by the community registry.
+ * Exported from a vite-free module so tests and tooling can validate manifests without
+ * paying the cost of loading vite + esbuild.
+ */
+export declare const serializeManifest: (meta: Plugin.Meta, { moduleFile }: {
+    moduleFile: string;
+}) => string;
+//# sourceMappingURL=manifest.d.ts.map

package/dist/types/src/vite-plugin/manifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../../../src/vite-plugin/manifest.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,kBAAkB,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,CAAC,IAAI,EAAE,gBAAgB;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,KAAG,MAC5C,CAAC"}

package/dist/types/src/vite-plugin/manifest.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=manifest.test.d.ts.map

package/dist/types/src/vite-plugin/manifest.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.test.d.ts","sourceRoot":"","sources":["../../../../src/vite-plugin/manifest.test.ts"],"names":[],"mappings":""}

package/dist/types/src/vite-plugin/packages.d.ts

@@ -0,0 +1,13 @@
+export declare const DEFAULT_PACKAGES: string[];
+/**
+ * True when the given bare specifier (or one of its subpaths) is provided by the
+ * Composer host at runtime and must not be re-bundled by a plugin.
+ *
+ * Matches only packages listed in {@link DEFAULT_PACKAGES} — the same list
+ * {@link importMapPlugin} consumes — so externalization cannot claim a package
+ * the host isn't actually mapping. Unknown `@dxos/*` packages fall through to
+ * normal bundling, which is the correct default for plugin-owned or yet-to-be
+ * shared workspace packages.
+ */
+export declare const isSharedPackage: (id: string) => boolean;
+//# sourceMappingURL=packages.d.ts.map

package/dist/types/src/vite-plugin/packages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"packages.d.ts","sourceRoot":"","sources":["../../../../src/vite-plugin/packages.ts"],"names":[],"mappings":"AAkCA,eAAO,MAAM,gBAAgB,UAqI5B,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,GAAI,IAAI,MAAM,KAAG,OAC2B,CAAC"}