@dxos/app-framework 0.8.4-main.f9ba587 → 0.8.4-main.fffef41

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/react/index.ts"],"names":[],"mappings":"AAIA,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/react/index.ts"],"names":[],"mappings":"AAIA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AAExB,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,WAAW,CAAC;AAE1B,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC"}

package/dist/types/src/react/types.d.ts

@@ -0,0 +1,14 @@
+import * as Schema from 'effect/Schema';
+import { type Obj } from '@dxos/echo';
+export declare const SurfaceCardRole: Schema.Literal<["card", "card--popover", "card--intrinsic", "card--extrinsic", "card--transclusion"]>;
+export type SurfaceCardRole = Schema.Schema.Type<typeof SurfaceCardRole>;
+export type SurfaceRole = 'item' | 'article' | 'complementary' | 'section' | SurfaceCardRole;
+/**
+ * Base type for surface components.
+ */
+export type SurfaceComponentProps<Subject extends Obj.Any = Obj.Any, Role extends string = string> = {
+    role?: Role;
+    /** The primary object being displayed. */
+    subject: Subject;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types/src/react/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/react/types.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AAEtC,eAAO,MAAM,eAAe,uGAM3B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,eAAe,CAAC,CAAC;AAGzE,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,SAAS,GACT,eAAe,GACf,SAAS,GACT,eAAe,CAAC;AAEpB;;GAEG;AAIH,MAAM,MAAM,qBAAqB,CAAC,OAAO,SAAS,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,EAAE,IAAI,SAAS,MAAM,GAAG,MAAM,IAAI;IACnG,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ,0CAA0C;IAC1C,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC"}

package/dist/types/src/{App.d.ts → react/useApp.d.ts}

@@ -1,7 +1,7 @@
 import React, { type FC } from 'react';
-import { PluginManager, type PluginManagerOptions, type Plugin } from './core';
-import { ErrorBoundary } from './react';
-export type CreateAppOptions = {
+import { type Plugin, PluginManager, type PluginManagerOptions } from '../core';
+import { ErrorBoundary } from './ErrorBoundary';
+export type UseAppOptions = {
     pluginManager?: PluginManager;
     pluginLoader?: PluginManagerOptions['pluginLoader'];
     plugins?: Plugin[];
@@ -13,6 +13,7 @@ export type CreateAppOptions = {
     fallback?: ErrorBoundary['props']['fallback'];
     cacheEnabled?: boolean;
     safeMode?: boolean;
+    debounce?: number;
 };
 /**
  * Expected usage is for this to be the entrypoint of the application.
@@ -23,7 +24,7 @@ export type CreateAppOptions = {
  * const core = [LayoutPluginId];
  * const default = [MyPluginId];
  * const fallback = <div>Initializing Plugins...</div>;
- * const App = createApp({ plugins, core, default, fallback });
+ * const App = useApp({ plugins, core, default, fallback });
  * createRoot(document.getElementById('root')!).render(
  *   <StrictMode>
  *     <App />
@@ -39,5 +40,5 @@ export type CreateAppOptions = {
  * @param params.cacheEnabled Whether to cache enabled plugins in localStorage.
  * @param params.safeMode Whether to enable safe mode, which disables optional plugins.
  */
-export declare const useApp: ({ pluginManager, pluginLoader: _pluginLoader, plugins: _plugins, core: _core, defaults: _defaults, placeholder, fallback, cacheEnabled, safeMode, }: CreateAppOptions) => () => React.JSX.Element;
-//# sourceMappingURL=App.d.ts.map
+export declare const useApp: ({ pluginManager, pluginLoader: pluginLoaderParam, plugins: pluginsParam, core: coreParam, defaults: defaultsParam, placeholder, fallback, cacheEnabled, safeMode, debounce, }: UseAppOptions) => () => React.JSX.Element;
+//# sourceMappingURL=useApp.d.ts.map

package/dist/types/src/react/useApp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useApp.d.ts","sourceRoot":"","sources":["../../../../src/react/useApp.tsx"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,EAAE,KAAK,EAAE,EAAmC,MAAM,OAAO,CAAC;AAOxE,OAAO,EAAE,KAAK,MAAM,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAIhF,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAKhD,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,YAAY,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,CAAC;IACpD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,WAAW,CAAC,EAAE,EAAE,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACpC,QAAQ,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC;IAC9C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,MAAM,GAAI,+KAWpB,aAAa,4BAwFf,CAAC"}

package/dist/types/src/react/useCapabilities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCapabilities.d.ts","sourceRoot":"","sources":["../../../../src/react/useCapabilities.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,EAAE,cAAc,YAAY,CAAC,CAAC,CAAC,QAG/D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,EAAE,cAAc,YAAY,CAAC,CAAC,CAAC,MAI7D,CAAC"}
+{"version":3,"file":"useCapabilities.d.ts","sourceRoot":"","sources":["../../../../src/react/useCapabilities.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,SAAS,CAAC;AAI5C;;;GAGG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,EAAE,cAAc,YAAY,CAAC,CAAC,CAAC,QAG/D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,EAAE,cAAc,YAAY,CAAC,CAAC,CAAC,MAI7D,CAAC"}

package/dist/types/src/react/useLoading.d.ts

@@ -0,0 +1,19 @@
+import { type AppProps } from './App';
+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: (state: AppProps["state"], debounce?: number) => LoadingState;
+//# sourceMappingURL=useLoading.d.ts.map

package/dist/types/src/react/useLoading.d.ts.map

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

package/dist/types/src/testing/withPluginManager.d.ts

@@ -1,16 +1,17 @@
-import { type Decorator } from '@storybook/react';
-import { type CreateAppOptions } from '../App';
+import { type Decorator, type StoryContext } from '@storybook/react';
+import { type MaybeProvider } from '@dxos/util';
 import { type ActivationEvent, type AnyCapability, type PluginContext } from '../core';
-export type Provider<C, R> = (context: C) => R;
-export type ProviderOrValue<C, R> = Provider<C, R> | R;
-export declare const getValue: <C, R>(providerOrValue: ProviderOrValue<C, R>, context: C) => R;
-export type WithPluginManagerOptions = CreateAppOptions & {
-    capabilities?: ProviderOrValue<PluginContext, AnyCapability[]>;
+import { type UseAppOptions } from '../react';
+export type WithPluginManagerOptions = UseAppOptions & {
+    /** @deprecated */
+    capabilities?: MaybeProvider<AnyCapability[], PluginContext>;
+    /** @deprecated */
     fireEvents?: (ActivationEvent | string)[];
 };
+export type WithPluginManagerInitializer<Args = void> = WithPluginManagerOptions | ((context: StoryContext<Args>) => WithPluginManagerOptions);
 /**
  * Wraps a story with a plugin manager.
  * NOTE: This builds up and tears down the plugin manager on every render.
  */
-export declare const withPluginManager: (options?: WithPluginManagerOptions) => Decorator;
+export declare const withPluginManager: <Args>(init?: WithPluginManagerInitializer<Args>) => Decorator;
 //# sourceMappingURL=withPluginManager.d.ts.map

package/dist/types/src/testing/withPluginManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"withPluginManager.d.ts","sourceRoot":"","sources":["../../../../src/testing/withPluginManager.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAKlD,OAAO,EAAU,KAAK,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAEvD,OAAO,EAIL,KAAK,eAAe,EACpB,KAAK,aAAa,EAElB,KAAK,aAAa,EACnB,MAAM,SAAS,CAAC;AAGjB,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;AAC/C,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;AACvD,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,CAAC,EAAE,iBAAiB,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC,KAAG,CAEnF,CAAC;AA+BF,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,GAAG;IACxD,YAAY,CAAC,EAAE,eAAe,CAAC,aAAa,EAAE,aAAa,EAAE,CAAC,CAAC;IAC/D,UAAU,CAAC,EAAE,CAAC,eAAe,GAAG,MAAM,CAAC,EAAE,CAAC;CAC3C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,UAAS,wBAA6B,KAAG,SAmC1E,CAAC"}
+{"version":3,"file":"withPluginManager.d.ts","sourceRoot":"","sources":["../../../../src/testing/withPluginManager.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAKrE,OAAO,EAAE,KAAK,aAAa,EAAoB,MAAM,YAAY,CAAC;AAGlE,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,aAAa,EAKnB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,UAAU,CAAC;AA+BtD,MAAM,MAAM,wBAAwB,GAAG,aAAa,GAAG;IACrD,kBAAkB;IAClB,YAAY,CAAC,EAAE,aAAa,CAAC,aAAa,EAAE,EAAE,aAAa,CAAC,CAAC;IAC7D,kBAAkB;IAClB,UAAU,CAAC,EAAE,CAAC,eAAe,GAAG,MAAM,CAAC,EAAE,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,4BAA4B,CAAC,IAAI,GAAG,IAAI,IAChD,wBAAwB,GACxB,CAAC,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,KAAK,wBAAwB,CAAC,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,IAAI,EAAG,OAAM,4BAA4B,CAAC,IAAI,CAAM,KAAG,SAgCxF,CAAC"}

package/dist/types/src/testing/withPluginManager.stories.d.ts

@@ -1,5 +1,11 @@
-import { type Meta } from '@dxos/storybook-utils';
-declare const meta: Meta;
+import { type StoryObj } from '@storybook/react-vite';
+import React from 'react';
+declare const meta: {
+    title: string;
+    render: () => React.JSX.Element;
+    decorators: import("@storybook/react").Decorator[];
+};
 export default meta;
-export declare const Default: {};
+type Story = StoryObj<typeof meta>;
+export declare const Default: Story;
 //# sourceMappingURL=withPluginManager.stories.d.ts.map

package/dist/types/src/testing/withPluginManager.stories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"withPluginManager.stories.d.ts","sourceRoot":"","sources":["../../../../src/testing/withPluginManager.stories.tsx"],"names":[],"mappings":"AAMA,OAAO,EAAa,KAAK,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAiB7D,QAAA,MAAM,IAAI,EAAE,IAkBX,CAAC;AAEF,eAAe,IAAI,CAAC;AAEpB,eAAO,MAAM,OAAO,IAAK,CAAC"}
+{"version":3,"file":"withPluginManager.stories.d.ts","sourceRoot":"","sources":["../../../../src/testing/withPluginManager.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAa,KAAK,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,MAAM,OAAO,CAAC;AAoB1B,QAAA,MAAM,IAAI;;;;CAkB2B,CAAC;AAEtC,eAAe,IAAI,CAAC;AAEpB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;AAEnC,eAAO,MAAM,OAAO,EAAE,KAAU,CAAC"}