@dxos/app-framework 0.7.4-staging.f7e8224 → 0.7.5-feature-compute.4d9d99a

package/dist/types/src/{plugins/common → common}/navigation.d.ts

@@ -1,7 +1,4 @@
 import { Schema as S } from '@effect/schema';
-import { z } from 'zod';
-import { type Plugin } from '../plugin-host';
-import { type IntentData } from '../plugin-intent';
 export declare const SLUG_LIST_SEPARATOR = "+";
 export declare const SLUG_ENTRY_SEPARATOR = "_";
 export declare const SLUG_KEY_VALUE_SEPARATOR = "-";
@@ -63,19 +60,19 @@ declare const LayoutCoordinateSchema: S.mutable<S.Struct<{
     entryId: typeof S.String;
 }>>;
 export type LayoutCoordinate = S.Schema.Type<typeof LayoutCoordinateSchema>;
-declare const PartAdjustmentSchema: S.Union<[S.Literal<["increment-start"]>, S.Literal<["increment-end"]>, S.Literal<["solo"]>]>;
+declare const PartAdjustmentSchema: S.Union<[S.Literal<["increment-start"]>, S.Literal<["increment-end"]>, S.Literal<["pin-start"]>, S.Literal<["pin-end"]>, S.Literal<["close"]>, S.Literal<["solo"]>]>;
 export type PartAdjustment = S.Schema.Type<typeof PartAdjustmentSchema>;
 declare const LayoutAdjustmentSchema: S.mutable<S.Struct<{
     layoutCoordinate: S.mutable<S.Struct<{
         part: S.Union<[S.Literal<["sidebar"]>, S.Literal<["main"]>, S.Literal<["solo"]>, S.Literal<["complementary"]>, S.Literal<["fullScreen"]>]>;
         entryId: typeof S.String;
     }>>;
-    type: S.Union<[S.Literal<["increment-start"]>, S.Literal<["increment-end"]>, S.Literal<["solo"]>]>;
+    type: S.Union<[S.Literal<["increment-start"]>, S.Literal<["increment-end"]>, S.Literal<["pin-start"]>, S.Literal<["pin-end"]>, S.Literal<["close"]>, S.Literal<["solo"]>]>;
 }>>;
 export type LayoutAdjustment = S.Schema.Type<typeof LayoutAdjustmentSchema>;
 /** @deprecated */
-export declare const ActiveParts: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
-export type ActiveParts = z.infer<typeof ActiveParts>;
+export declare const ActiveParts: S.Record$<typeof S.String, S.Union<[typeof S.String, S.mutable<S.Array$<typeof S.String>>]>>;
+export type ActiveParts = S.Schema.Type<typeof ActiveParts>;
 export type LayoutContainerProps<T> = T & {
     role?: string;
     coordinate?: LayoutCoordinate;
@@ -137,7 +134,6 @@ export type LocationProvides = S.Schema.Type<typeof LocationProvidesSchema>;
  */
 export declare const isLayoutParts: (value: unknown) => value is LayoutParts;
 export declare const isLayoutAdjustment: (value: unknown) => value is LayoutAdjustment;
-export declare const parseNavigationPlugin: (plugin: Plugin) => Plugin<LocationProvides> | undefined;
 /**
  * Utilities.
  */
@@ -146,51 +142,100 @@ export declare const openIds: (layout: LayoutParts, parts?: LayoutPart[]) => str
 export declare const firstIdInPart: (layout: LayoutParts | undefined, part: LayoutPart) => string | undefined;
 export declare const indexInPart: (layout: LayoutParts | undefined, layoutCoordinate: LayoutCoordinate | undefined) => number | undefined;
 export declare const partLength: (layout: LayoutParts | undefined, part: LayoutPart | undefined) => number;
-export declare enum NavigationAction {
-    OPEN = "dxos.org/plugin/navigation/action/open",
-    ADD_TO_ACTIVE = "dxos.org/plugin/navigation/action/add-to-active",
-    SET = "dxos.org/plugin/navigation/action/set",
-    ADJUST = "dxos.org/plugin/navigation/action/adjust",
-    CLOSE = "dxos.org/plugin/navigation/action/close",
-    EXPOSE = "dxos.org/plugin/navigation/action/expose"
-}
+export declare const NAVIGATION_PLUGIN = "dxos.org/plugin/navigation";
+export declare const NAVIGATION_ACTION = "dxos.org/plugin/navigation/action";
 /**
  * Expected payload for navigation actions.
  */
 export declare namespace NavigationAction {
+    const Open_base: S.TaggedClass<Open, "dxos.org/plugin/navigation/action/open", {
+        readonly _tag: S.tag<"dxos.org/plugin/navigation/action/open">;
+    } & {
+        input: S.Struct<{
+            activeParts: S.Record$<typeof S.String, S.Union<[typeof S.String, S.mutable<S.Array$<typeof S.String>>]>>;
+            noToggle: S.optional<typeof S.Boolean>;
+        }>;
+        output: S.Struct<{
+            open: S.Array$<typeof S.String>;
+        }>;
+    }>;
     /**
      * An additive overlay to apply to `location.active` (i.e. the result is a union of previous active and the argument)
      */
-    type Open = IntentData<{
-        activeParts: ActiveParts;
+    export class Open extends Open_base {
+    }
+    const AddToActive_base: S.TaggedClass<AddToActive, "dxos.org/plugin/navigation/action/add-to-active", {
+        readonly _tag: S.tag<"dxos.org/plugin/navigation/action/add-to-active">;
+    } & {
+        input: S.Struct<{
+            id: typeof S.String;
+            part: S.Union<[S.Literal<["sidebar"]>, S.Literal<["main"]>, S.Literal<["solo"]>, S.Literal<["complementary"]>, S.Literal<["fullScreen"]>]>;
+            scrollIntoView: S.optional<typeof S.Boolean>;
+            pivotId: S.optional<typeof S.String>;
+            positioning: S.optional<S.Literal<["start", "end"]>>;
+        }>;
+        output: typeof S.Void;
     }>;
     /**
      * Payload for adding an item to the active items.
      */
-    type AddToActive = IntentData<{
-        part: LayoutPart;
-        id: string;
-        scrollIntoView?: boolean;
-        pivotId?: string;
-        positioning?: 'start' | 'end';
+    export class AddToActive extends AddToActive_base {
+    }
+    const Set_base: S.TaggedClass<Set, "dxos.org/plugin/navigation/action/set", {
+        readonly _tag: S.tag<"dxos.org/plugin/navigation/action/set">;
+    } & {
+        input: S.Struct<{
+            activeParts: S.Record$<typeof S.String, S.Union<[typeof S.String, S.mutable<S.Array$<typeof S.String>>]>>;
+        }>;
+        output: typeof S.Void;
     }>;
     /**
-     * A subtractive overlay to apply to `location.active` (i.e. the result is a subtraction from the previous active of the argument)
+     * The active parts to directly set, to be used when working with URLs or restoring a specific state.
      */
-    type Close = IntentData<{
-        activeParts: ActiveParts;
-        noToggle?: boolean;
+    export class Set extends Set_base {
+    }
+    const Close_base: S.TaggedClass<Close, "dxos.org/plugin/navigation/action/close", {
+        readonly _tag: S.tag<"dxos.org/plugin/navigation/action/close">;
+    } & {
+        input: S.Struct<{
+            activeParts: S.Record$<typeof S.String, S.Union<[typeof S.String, S.mutable<S.Array$<typeof S.String>>]>>;
+            noToggle: S.optional<typeof S.Boolean>;
+        }>;
+        output: typeof S.Void;
     }>;
     /**
-     * The active parts to directly set, to be used when working with URLs or restoring a specific state.
+     * A subtractive overlay to apply to `location.active` (i.e. the result is a subtraction from the previous active of the argument)
      */
-    type Set = IntentData<{
-        activeParts: ActiveParts;
+    export class Close extends Close_base {
+    }
+    const Adjust_base: S.TaggedClass<Adjust, "dxos.org/plugin/navigation/action/adjust", {
+        readonly _tag: S.tag<"dxos.org/plugin/navigation/action/adjust">;
+    } & {
+        input: S.mutable<S.Struct<{
+            layoutCoordinate: S.mutable<S.Struct<{
+                part: S.Union<[S.Literal<["sidebar"]>, S.Literal<["main"]>, S.Literal<["solo"]>, S.Literal<["complementary"]>, S.Literal<["fullScreen"]>]>;
+                entryId: typeof S.String;
+            }>>;
+            type: S.Union<[S.Literal<["increment-start"]>, S.Literal<["increment-end"]>, S.Literal<["pin-start"]>, S.Literal<["pin-end"]>, S.Literal<["close"]>, S.Literal<["solo"]>]>;
+        }>>;
+        output: typeof S.Void;
     }>;
     /**
      * An atomic transaction to apply to `location.active`, describing which element to (attempt to) move to which location.
      */
-    type Adjust = IntentData<LayoutAdjustment>;
+    export class Adjust extends Adjust_base {
+    }
+    const Expose_base: S.TaggedClass<Expose, "dxos.org/plugin/navigation/action/expose", {
+        readonly _tag: S.tag<"dxos.org/plugin/navigation/action/expose">;
+    } & {
+        input: S.Struct<{
+            id: typeof S.String;
+        }>;
+        output: typeof S.Void;
+    }>;
+    export class Expose extends Expose_base {
+    }
+    export {};
 }
 export {};
 //# sourceMappingURL=navigation.d.ts.map

package/dist/types/src/common/navigation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../../../../src/common/navigation.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,gBAAgB,CAAC;AAK7C,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,eAAO,MAAM,oBAAoB,MAAM,CAAC;AACxC,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAC5C,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,eAAO,MAAM,yBAAyB,KAAK,CAAC;AAE5C,QAAA,MAAM,iBAAiB;;;GAAoE,CAAC;AAC5F,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAIlE,QAAA,MAAM,gBAAgB,sIAMrB,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEhE,QAAA,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAEtB,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAElE,QAAA,MAAM,sBAAsB;;;GAAqE,CAAC;AAClG,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAE5E,QAAA,MAAM,oBAAoB,sKAOzB,CAAC;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAExE,QAAA,MAAM,sBAAsB;;;;;;GAE3B,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAE5E,kBAAkB;AAClB,eAAO,MAAM,WAAW,8FAAsF,CAAC;AAC/G,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,WAAW,CAAC,CAAC;AAG5D,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,gBAAgB,CAAA;CAAE,CAAC;AAE3F;;GAEG;AACH,QAAA,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAO3B,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,aAAa,UAAW,OAAO,KAAG,KAAK,IAAI,WAEvD,CAAC;AAGF,eAAO,MAAM,kBAAkB,UAAW,OAAO,KAAG,KAAK,IAAI,gBAE5D,CAAC;AAEF;;GAEG;AAEH,qDAAqD;AACrD,eAAO,MAAM,OAAO,WAAY,WAAW,UAAU,UAAU,EAAE,KAAG,MAAM,EAIzE,CAAC;AAEF,eAAO,MAAM,aAAa,WAAY,WAAW,GAAG,SAAS,QAAQ,UAAU,KAAG,MAAM,GAAG,SAM1F,CAAC;AAEF,eAAO,MAAM,WAAW,WACd,WAAW,GAAG,SAAS,oBACb,gBAAgB,GAAG,SAAS,KAC7C,MAAM,GAAG,SAOX,CAAC;AAEF,eAAO,MAAM,UAAU,WAAY,WAAW,GAAG,SAAS,QAAQ,UAAU,GAAG,SAAS,KAAG,MAM1F,CAAC;AAMF,eAAO,MAAM,iBAAiB,+BAA+B,CAAC;AAC9D,eAAO,MAAM,iBAAiB,sCAAgC,CAAC;AAE/D;;GAEG;AAEH,yBAAiB,gBAAgB,CAAC;;;;;;;;;;;;IAChC;;OAEG;IACH,MAAM,OAAO,IAAK,SAAQ,SAQxB;KAAG;;;;;;;;;;;;;IAEL;;OAEG;IACH,MAAM,OAAO,WAAY,SAAQ,gBAS/B;KAAG;;;;;;;;;IAEL;;OAEG;IACH,MAAM,OAAO,GAAI,SAAQ,QAKvB;KAAG;;;;;;;;;;IAEL;;OAEG;IACH,MAAM,OAAO,KAAM,SAAQ,UAMzB;KAAG;;;;;;;;;;;;;IAEL;;OAEG;IACH,MAAM,OAAO,MAAO,SAAQ,WAG1B;KAAG;;;;;;;;;IAGL,MAAM,OAAO,MAAO,SAAQ,WAK1B;KAAG;;CACN"}

package/dist/types/src/common/surface.d.ts

@@ -0,0 +1,68 @@
+import { type JSX, type ForwardedRef, type PropsWithChildren, type ReactNode } from 'react';
+import { type GuardedType, type MakeOptional, type Disposition } from '@dxos/util';
+import { type ErrorBoundary } from '../react';
+/**
+ * SurfaceProps are the props that are passed to the Surface component.
+ */
+export type SurfaceProps<T extends Record<string, any> = Record<string, unknown>> = PropsWithChildren<{
+    /**
+     * If specified, the Surface will be wrapped in an error boundary.
+     * The fallback component will be rendered if an error occurs.
+     */
+    fallback?: ErrorBoundary['props']['fallback'];
+    /**
+     * If specified, the Surface will be wrapped in a suspense boundary.
+     * The placeholder component will be rendered while the surface component is loading.
+     */
+    placeholder?: ReactNode;
+}> & MakeOptional<CoreSurfaceProps<T>, 'id' | 'data'> & {
+    /**
+     * Additional props to pass to the component.
+     * These props are not used by Surface itself but may be used by components which resolve the surface.
+     */
+    [key: string]: unknown;
+};
+type CoreSurfaceProps<T extends Record<string, any> = Record<string, unknown>> = {
+    /**
+     * ID for debugging.
+     */
+    id: string;
+    /**
+     * Role defines how the data should be rendered.
+     */
+    role: string;
+    /**
+     * The data to be rendered by the surface.
+     */
+    data: T;
+    /**
+     * If more than one component is resolved, the limit determines how many are rendered.
+     */
+    limit?: number | undefined;
+};
+type SurfaceComponentProps<T extends Record<string, any> = Record<string, unknown>> = PropsWithChildren<CoreSurfaceProps<T> & {
+    [key: string]: unknown;
+}>;
+/**
+ * React component used to render a surface once is has matched.
+ */
+export type SurfaceComponent<T extends Record<string, any> = Record<string, unknown>> = (props: SurfaceComponentProps<T>, forwardedRef: ForwardedRef<HTMLElement>) => JSX.Element | null;
+/**
+ * Definition of when a SurfaceComponent should be rendered.
+ */
+export type SurfaceDefinition<T extends Record<string, any> = any> = Readonly<{
+    id: string;
+    role: string | string[];
+    disposition?: Disposition;
+    filter?: (data: Record<string, unknown>) => data is T;
+    component: SurfaceComponent<GuardedType<SurfaceDefinition<T>['filter']>>;
+}>;
+export declare const createSurface: <T extends Record<string, any> = any>(definition: SurfaceDefinition<T>) => Readonly<{
+    id: string;
+    role: string | string[];
+    disposition?: Disposition;
+    filter?: ((data: Record<string, unknown>) => data is T) | undefined;
+    component: SurfaceComponent<T>;
+}>;
+export {};
+//# sourceMappingURL=surface.d.ts.map

package/dist/types/src/common/surface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"surface.d.ts","sourceRoot":"","sources":["../../../../src/common/surface.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,GAAG,EAAE,KAAK,YAAY,EAAE,KAAK,iBAAiB,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAE5F,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAEnF,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,iBAAiB,CAAC;IACpG;;;OAGG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC;IAE9C;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,CAAC;CACzB,CAAC,GACA,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC,GAAG;IACjD;;;OAGG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAGJ,KAAK,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC/E;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;IAER;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,CAAC;AAEF,KAAK,qBAAqB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,iBAAiB,CACrG,gBAAgB,CAAC,CAAC,CAAC,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CACtF,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,EAC/B,YAAY,EAAE,YAAY,CAAC,WAAW,CAAC,KACpC,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,IAAI,QAAQ,CAAC;IAC5E,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACxB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;IACtD,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;CAC1E,CAAC,CAAC;AAEH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,oBAAoB,iBAAiB,CAAC,CAAC,CAAC;QAP7F,MAAM;UACJ,MAAM,GAAG,MAAM,EAAE;kBACT,WAAW;qBACT,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,KAAK;;EAI2D,CAAC"}

package/dist/types/src/{plugins/common → common}/translations.d.ts

@@ -1,5 +1,4 @@
 import { z } from 'zod';
-import { type Plugin } from '../plugin-host';
 export declare const ResourceKey: z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>]>;
 export type ResourceKey = z.infer<typeof ResourceKey>;
 export declare const ResourceLanguage: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
@@ -9,14 +8,4 @@ export type ResourceLanguage = z.infer<typeof ResourceLanguage>;
  */
 export declare const Resource: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>]>>>;
 export type Resource = z.infer<typeof Resource>;
-/**
- * Provides for a plugin that exposes translations.
- */
-export type TranslationsProvides = {
-    translations: Readonly<Resource[]>;
-};
-/**
- * Type guard for translation plugins.
- */
-export declare const parseTranslationsPlugin: (plugin: Plugin) => Plugin<TranslationsProvides> | undefined;
 //# sourceMappingURL=translations.d.ts.map

package/dist/types/src/common/translations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../../src/common/translations.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,eAAO,MAAM,WAAW,+DAA2C,CAAC;AACpE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAEtD,eAAO,MAAM,gBAAgB,yFAAwB,CAAC;AACtD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,QAAQ,mHAA6B,CAAC;AACnD,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC"}

package/dist/types/src/core/capabilities.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Interface definition for a capability.
+ */
+import { type Effect } from 'effect';
+import { type MaybePromise } from '@dxos/util';
+import { type ActivationEvent } from './events';
+declare const InterfaceDefTypeId: unique symbol;
+/**
+ * The interface definition of a capability.
+ */
+export type InterfaceDef<T> = {
+    [InterfaceDefTypeId]: T;
+    identifier: string;
+};
+/**
+ * Helper to define the interface of a capability.
+ */
+export declare const defineCapability: <T>(identifier: string) => InterfaceDef<T>;
+/**
+ * Functionality contributed to the application by a plugin module.
+ */
+export type Capability<T> = {
+    /**
+     * The interface definition of the capability.
+     */
+    interface: InterfaceDef<T>;
+    /**
+     * The implementation of the capability.
+     */
+    implementation: T;
+    /**
+     * Called when the capability is deactivated.
+     */
+    deactivate?: () => MaybePromise<void> | Effect.Effect<void, Error>;
+};
+export type AnyCapability = Capability<any>;
+type PluginsContextOptions = {
+    activate: (event: ActivationEvent) => MaybePromise<boolean>;
+    reset: (event: ActivationEvent) => MaybePromise<boolean>;
+};
+/**
+ * Helper to define the implementation of a capability.
+ */
+export declare const contributes: <T>(interfaceDef: Capability<T>["interface"], implementation: Capability<T>["implementation"], deactivate?: Capability<T>["deactivate"]) => Capability<T>;
+type LazyCapability<T, U> = () => Promise<{
+    default: (props: T) => MaybePromise<Capability<U>>;
+}>;
+/**
+ * Helper to define a lazily loaded implementation of a capability.
+ */
+export declare const lazy: <T, U>(c: LazyCapability<T, U>) => (props?: T) => Promise<Capability<U>>;
+/**
+ * Context which is passed to plugins, allowing them to interact with each other.
+ */
+export declare class PluginsContext {
+    private readonly _definedCapabilities;
+    /**
+     * Activates plugins based on the activation event.
+     * @param event The activation event.
+     * @returns Whether the activation was successful.
+     */
+    readonly activate: PluginsContextOptions['activate'];
+    /**
+     * Re-activates the modules that were activated by the event.
+     * @param event The activation event.
+     * @returns Whether the reset was successful.
+     */
+    readonly reset: PluginsContextOptions['reset'];
+    constructor({ activate, reset }: PluginsContextOptions);
+    /**
+     * Requests capabilities from the plugin context.
+     * @returns An array of capabilities.
+     * @reactive
+     */
+    requestCapabilities<T, U extends T = T>(interfaceDef: InterfaceDef<T>, filter?: (capability: T, moduleId: string) => capability is U): U[];
+    /**
+     * Requests a single capability from the plugin context.
+     * @returns The capability.
+     * @throws If no capability is found.
+     * @reactive
+     */
+    requestCapability<T, U extends T = T>(interfaceDef: InterfaceDef<T>, filter?: (capability: T, moduleId: string) => capability is U): U;
+    /**
+     * Waits for a capability to be contributed.
+     * @returns The capability.
+     */
+    waitForCapability<T, U extends T = T>(interfaceDef: InterfaceDef<T>, filter?: (capability: T) => capability is U): Promise<U>;
+}
+export {};
+//# sourceMappingURL=capabilities.d.ts.map

package/dist/types/src/core/capabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../../../src/core/capabilities.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,QAAQ,CAAC;AAMrC,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,UAAU,CAAC;AAEhD,QAAA,MAAM,kBAAkB,EAAE,OAAO,MAAyC,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI;IAC5B,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,cAAc,MAAM,KAC3B,YAAY,CAAC,CAAC,CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;IAC1B;;OAEG;IACH,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAE3B;;OAEG;IACH,cAAc,EAAE,CAAC,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,YAAY,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;CACpE,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;AAE5C,KAAK,qBAAqB,GAAG;IAC3B,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC;IAC5D,KAAK,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC;CAC1D,CAAC;AAUF;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,gBACb,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,kBACxB,UAAU,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,eAClC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,KACvC,UAAU,CAAC,CAAC,CAEd,CAAC;AAEF,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,IAAI,MAAM,OAAO,CAAC;IAAE,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;CAAE,CAAC,CAAC;AAElG;;GAEG;AACH,eAAO,MAAM,IAAI,GACd,CAAC,EAAE,CAAC,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,cACrB,CAAC,KAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAG9B,CAAC;AAEP;;GAEG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAgD;IAErF;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAErD;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,qBAAqB,CAAC,OAAO,CAAC,CAAC;gBAEnC,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,qBAAqB;IA4CtD;;;;OAIG;IACH,mBAAmB,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,EACpC,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC,EAC7B,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,KAAK,UAAU,IAAI,CAAC,GAC5D,CAAC,EAAE;IAaN;;;;;OAKG;IACH,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,EAClC,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC,EAC7B,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,KAAK,UAAU,IAAI,CAAC,GAC5D,CAAC;IAMJ;;;OAGG;IACG,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,EACxC,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC,EAC7B,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,KAAK,UAAU,IAAI,CAAC,GAC1C,OAAO,CAAC,CAAC,CAAC;CAYd"}

package/dist/types/src/core/capabilities.test.d.ts

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

package/dist/types/src/core/capabilities.test.d.ts.map

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

package/dist/types/src/core/events.d.ts

@@ -0,0 +1,58 @@
+/**
+ * An event which activates a plugin module.
+ */
+export type ActivationEvent = {
+    id: string;
+    specifier?: string;
+};
+/**
+ * An activation event that can be a single event, or a combination of events.
+ */
+export type ActivationEvents = ActivationEvent | {
+    type: 'one-of';
+    events: ActivationEvent[];
+} | {
+    type: 'all-of';
+    events: ActivationEvent[];
+};
+/**
+ * Helper to define an activation event.
+ */
+export declare const defineEvent: (id: string, specifier?: string) => ActivationEvent;
+/**
+ * Helper to create an activation event key.
+ */
+export declare const eventKey: (event: ActivationEvent) => string;
+/**
+ * Helper to create an activation event that triggers when any of the given events are activated.
+ */
+export declare const oneOf: (...events: ActivationEvent[]) => {
+    type: "one-of";
+    events: ActivationEvent[];
+};
+/**
+ * Helper to create an activation event that triggers when all of the given events are activated.
+ */
+export declare const allOf: (...events: ActivationEvent[]) => {
+    type: "all-of";
+    events: ActivationEvent[];
+};
+/**
+ * Helper to check if an activation event is a one-of event.
+ */
+export declare const isOneOf: (events: ActivationEvents) => events is {
+    type: "one-of";
+    events: ActivationEvent[];
+};
+/**
+ * Helper to check if an activation event is an all-of event.
+ */
+export declare const isAllOf: (events: ActivationEvents) => events is {
+    type: "all-of";
+    events: ActivationEvent[];
+};
+/**
+ * Helper to get the events from an activation event.
+ */
+export declare const getEvents: (events: ActivationEvents) => ActivationEvent[];
+//# sourceMappingURL=events.d.ts.map

package/dist/types/src/core/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../src/core/events.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,eAAe,EAAE,CAAA;CAAE,GAC7C;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,eAAe,EAAE,CAAA;CAAE,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,WAAW,OAAQ,MAAM,cAAc,MAAM,KAC5B,eAC7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,UAAW,eAAe,WAAoE,CAAC;AAEpH;;GAEG;AACH,eAAO,MAAM,KAAK,cAAe,eAAe,EAAE;;;CAA0C,CAAC;AAE7F;;GAEG;AACH,eAAO,MAAM,KAAK,cAAe,eAAe,EAAE;;;CAA0C,CAAC;AAE7F;;GAEG;AACH,eAAO,MAAM,OAAO,WAAY,gBAAgB,KAAG,MAAM,IAAI;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,eAAe,EAAE,CAAA;CAC1D,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,OAAO,WAAY,gBAAgB,KAAG,MAAM,IAAI;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,eAAe,EAAE,CAAA;CAC1D,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,SAAS,WAAY,gBAAgB,sBAAkD,CAAC"}

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

@@ -0,0 +1,5 @@
+export * from './capabilities';
+export * from './events';
+export * from './manager';
+export * from './plugin';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/core/index.ts"],"names":[],"mappings":"AAIA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC"}

package/dist/types/src/core/manager.d.ts

@@ -0,0 +1,126 @@
+import { Event } from '@dxos/async';
+import { type ReactiveObject } from '@dxos/live-object';
+import { type MaybePromise } from '@dxos/util';
+import { PluginsContext } from './capabilities';
+import { type ActivationEvent } from './events';
+import { type PluginModule, type Plugin } from './plugin';
+export type PluginManagerOptions = {
+    pluginLoader: (id: string) => MaybePromise<Plugin>;
+    plugins?: Plugin[];
+    core?: string[];
+    enabled?: string[];
+};
+export declare class PluginManager {
+    readonly activation: Event<{
+        event: string;
+        state: "activating" | "activated" | "error";
+        error?: any;
+    }>;
+    readonly context: PluginsContext;
+    private readonly _state;
+    private readonly _pluginLoader;
+    private readonly _capabilities;
+    constructor({ pluginLoader, plugins, core, enabled, }: PluginManagerOptions);
+    /**
+     * Plugins that are currently registered.
+     *
+     * @reactive
+     */
+    get plugins(): ReactiveObject<readonly Plugin[]>;
+    /**
+     * Ids of plugins that are core and cannot be removed.
+     *
+     * @reactive
+     */
+    get core(): ReactiveObject<readonly string[]>;
+    /**
+     * Ids of plugins that are currently enabled.
+     *
+     * @reactive
+     */
+    get enabled(): ReactiveObject<readonly string[]>;
+    /**
+     * Modules of plugins which are currently enabled.
+     *
+     * @reactive
+     */
+    get modules(): ReactiveObject<readonly PluginModule[]>;
+    /**
+     * Ids of modules which are currently active.
+     *
+     * @reactive
+     */
+    get active(): ReactiveObject<readonly string[]>;
+    /**
+     * Ids of modules which are pending removal.
+     *
+     * @reactive
+     */
+    get pendingRemoval(): ReactiveObject<readonly string[]>;
+    /**
+     * Ids of events which have been fired.
+     *
+     * @reactive
+     */
+    get eventsFired(): ReactiveObject<readonly string[]>;
+    /**
+     * Ids of modules which are pending reset.
+     *
+     * @reactive
+     */
+    get pendingReset(): ReactiveObject<readonly string[]>;
+    /**
+     * Adds a plugin to the manager via the plugin loader.
+     * @param id The id of the plugin.
+     */
+    add(id: string): Promise<boolean>;
+    /**
+     * Enables a plugin.
+     * @param id The id of the plugin.
+     */
+    enable(id: string): boolean;
+    /**
+     * Removes a plugin from the manager.
+     * @param id The id of the plugin.
+     */
+    remove(id: string): boolean;
+    /**
+     * Disables a plugin.
+     * @param id The id of the plugin.
+     */
+    disable(id: string): boolean;
+    /**
+     * Activates plugins based on the activation event.
+     * @param event The activation event.
+     * @returns Whether the activation was successful.
+     */
+    activate(event: ActivationEvent | string): Promise<boolean>;
+    /**
+     * Deactivates all of the modules for a plugin.
+     * @param id The id of the plugin.
+     * @returns Whether the deactivation was successful.
+     */
+    deactivate(id: string): Promise<boolean>;
+    /**
+     * Re-activates the modules that were activated by the event.
+     * @param event The activation event.
+     * @returns Whether the reset was successful.
+     */
+    reset(event: ActivationEvent | string): Promise<boolean>;
+    private _addPlugin;
+    private _removePlugin;
+    private _addModule;
+    private _removeModule;
+    private _getPlugin;
+    private _getActiveModules;
+    private _getInactiveModules;
+    private _getActiveModulesByEvent;
+    private _getInactiveModulesByEvent;
+    private _setPendingResetByModule;
+    private _activate;
+    private _activateModule;
+    private _deactivate;
+    private _deactivateModule;
+    private _reset;
+}
+//# sourceMappingURL=manager.d.ts.map

package/dist/types/src/core/manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manager.d.ts","sourceRoot":"","sources":["../../../../src/core/manager.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAU,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEhE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAsB,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACpE,OAAO,EAAE,KAAK,eAAe,EAAgC,MAAM,UAAU,CAAC;AAC9E,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAO1D,MAAM,MAAM,oBAAoB,GAAG;IACjC,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;IACnD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAkBF,qBAAa,aAAa;IACxB,QAAQ,CAAC,UAAU;eAAsB,MAAM;eAAS,YAAY,GAAG,WAAW,GAAG,OAAO;gBAAU,GAAG;OAAM;IAE/G,QAAQ,CAAC,OAAO,iBAGb;IAEH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqC;IAC5D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAuC;IACrE,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAsC;gBAExD,EACV,YAAY,EACZ,OAAY,EACZ,IAAyC,EACzC,OAAY,GACb,EAAE,oBAAoB;IAiBvB;;;;OAIG;IACH,IAAI,OAAO,IAAI,cAAc,CAAC,SAAS,MAAM,EAAE,CAAC,CAE/C;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,cAAc,CAAC,SAAS,MAAM,EAAE,CAAC,CAE5C;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,cAAc,CAAC,SAAS,MAAM,EAAE,CAAC,CAE/C;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,cAAc,CAAC,SAAS,YAAY,EAAE,CAAC,CAErD;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,cAAc,CAAC,SAAS,MAAM,EAAE,CAAC,CAE9C;IAED;;;;OAIG;IACH,IAAI,cAAc,IAAI,cAAc,CAAC,SAAS,MAAM,EAAE,CAAC,CAEtD;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,cAAc,CAAC,SAAS,MAAM,EAAE,CAAC,CAEnD;IAED;;;;OAIG;IACH,IAAI,YAAY,IAAI,cAAc,CAAC,SAAS,MAAM,EAAE,CAAC,CAEpD;IAED;;;OAGG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IASvC;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAoB3B;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAa3B;;;OAGG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAgC5B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3D;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxC;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,eAAe,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxD,OAAO,CAAC,UAAU;IASlB,OAAO,CAAC,aAAa;IAUrB,OAAO,CAAC,UAAU;IASlB,OAAO,CAAC,aAAa;IAUrB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,wBAAwB;IAIhC,OAAO,CAAC,0BAA0B;IAIlC,OAAO,CAAC,wBAAwB;IAuBhC,OAAO,CAAC,SAAS;IAkDjB,OAAO,CAAC,eAAe;IA2BvB,OAAO,CAAC,WAAW;IAcnB,OAAO,CAAC,iBAAiB;IAmCzB,OAAO,CAAC,MAAM;CAsBf"}

package/dist/types/src/core/manager.test.d.ts

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

package/dist/types/src/core/manager.test.d.ts.map

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