@dxos/app-framework 0.8.4-main.dedc0f3 → 0.8.4-main.dfabb4ec29

package/dist/lib/node-esm/chunk-HTBJU5FX.mjs

@@ -0,0 +1,214 @@
+import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
+import {
+  getModuleTag
+} from "./chunk-SDJ4B2LU.mjs";
+import {
+  __export
+} from "./chunk-HSLMI22Q.mjs";
+
+// src/core/plugin.ts
+var plugin_exports = {};
+__export(plugin_exports, {
+  LazyPluginError: () => LazyPluginError,
+  PluginModuleTypeId: () => PluginModuleTypeId,
+  PluginTypeId: () => PluginTypeId,
+  Service: () => Service,
+  activate: () => activate,
+  addModule: () => addModule,
+  define: () => define,
+  isLazy: () => isLazy,
+  isPlugin: () => isPlugin,
+  isPluginModule: () => isPluginModule,
+  lazy: () => lazy,
+  make: () => make,
+  reset: () => reset,
+  resolveLazy: () => resolveLazy,
+  shutdown: () => shutdown
+});
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Option from "effect/Option";
+import * as Pipeable from "effect/Pipeable";
+import { BaseError } from "@dxos/errors";
+import { invariant } from "@dxos/invariant";
+var __dxlog_file = "/__w/dxos/dxos/packages/sdk/app-framework/src/core/plugin.ts";
+var Service = class extends Context.Tag("@dxos/app-framework/PluginManager")() {
+};
+var activate = (event) => Effect.flatMap(Service, (manager) => manager.activate(event));
+var reset = (event) => Effect.flatMap(Service, (manager) => manager.reset(event));
+var shutdown = () => Effect.flatMap(Service, (manager) => manager.shutdown());
+var computeModuleId = (pluginId, moduleName) => {
+  return `${pluginId}.module.${moduleName}`;
+};
+var PluginModuleTypeId = /* @__PURE__ */ Symbol.for("@dxos/app-framework/PluginModule");
+var isPluginModule = (value) => {
+  return typeof value === "object" && value !== null && PluginModuleTypeId in value;
+};
+var PluginModuleImpl = class {
+  [PluginModuleTypeId] = PluginModuleTypeId;
+  id;
+  activatesOn;
+  firesBeforeActivation;
+  firesAfterActivation;
+  activate;
+  constructor(options) {
+    this.id = options.id;
+    this.activatesOn = options.activatesOn;
+    this.firesBeforeActivation = options.firesBeforeActivation;
+    this.firesAfterActivation = options.firesAfterActivation;
+    this.activate = options.activate;
+  }
+};
+var PluginTypeId = /* @__PURE__ */ Symbol.for("@dxos/app-framework/Plugin");
+var isPlugin = (value) => {
+  return typeof value === "object" && value !== null && PluginTypeId in value;
+};
+var PluginImpl = class {
+  _meta;
+  _modules;
+  [PluginTypeId] = PluginTypeId;
+  constructor(_meta, _modules) {
+    this._meta = _meta;
+    this._modules = _modules;
+  }
+  get meta() {
+    return this._meta;
+  }
+  get modules() {
+    return this._modules;
+  }
+};
+var PluginBuilderImpl = class {
+  meta;
+  _modules = [];
+  constructor(meta) {
+    this.meta = meta;
+  }
+  get modules() {
+    return this._modules;
+  }
+  addModule(moduleOptions) {
+    this._modules.push(moduleOptions);
+    return this;
+  }
+  pipe() {
+    return Pipeable.pipeArguments(this, arguments);
+  }
+};
+var define = (meta) => new PluginBuilderImpl(meta);
+function addModule(moduleOptionsOrBuilder, moduleOptions) {
+  if (moduleOptions !== void 0) {
+    return moduleOptionsOrBuilder.addModule(moduleOptions);
+  }
+  const moduleOpts = moduleOptionsOrBuilder;
+  return (builder) => builder.addModule(moduleOpts);
+}
+var resolveModule = (meta, module, options) => {
+  const moduleOptions = typeof module === "function" ? module(options) : module;
+  const id = Option.fromNullable(moduleOptions.id).pipe(Option.match({
+    onNone: () => {
+      const exportName = getModuleTag(moduleOptions.activate);
+      invariant(exportName, `Plugin module missing name. Plugin: ${meta.id}`, { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 131, S: void 0, A: ["exportName", "`Plugin module missing name. Plugin: ${meta.id}`"] });
+      return computeModuleId(meta.id, exportName);
+    },
+    onSome: (id2) => computeModuleId(meta.id, id2)
+  }));
+  return new PluginModuleImpl({
+    ...moduleOptions,
+    id
+  });
+};
+function make(builder) {
+  const meta = builder.meta;
+  const factory = (options) => {
+    const modules = builder.modules.map((module) => resolveModule(meta, module, options));
+    return new PluginImpl(meta, modules);
+  };
+  return Object.assign(factory, {
+    meta
+  });
+}
+var LazyTag = /* @__PURE__ */ Symbol.for("@dxos/app-framework/Plugin/Lazy");
+var lazy = (meta, loader) => {
+  const factory = (options) => {
+    const stub = new PluginImpl(meta, []);
+    Object.defineProperty(stub, LazyTag, {
+      value: {
+        loader,
+        options
+      },
+      enumerable: false
+    });
+    return stub;
+  };
+  return Object.assign(factory, {
+    meta
+  });
+};
+var isLazy = (plugin) => LazyTag in plugin;
+var LazyPluginError = class extends BaseError.extend("LazyPluginError", "Failed to resolve lazy plugin") {
+};
+var resolveLazy = (plugin) => Effect.gen(function* () {
+  if (!isLazy(plugin)) {
+    return plugin;
+  }
+  const id = plugin.meta.id;
+  const { loader, options } = plugin[LazyTag];
+  const mod = yield* Effect.tryPromise({
+    try: loader,
+    catch: (error) => new LazyPluginError({
+      context: {
+        id,
+        reason: "load-failed"
+      },
+      cause: error
+    })
+  });
+  if (!mod || typeof mod.default !== "function") {
+    return yield* Effect.fail(new LazyPluginError({
+      context: {
+        id,
+        reason: "missing-default"
+      }
+    }));
+  }
+  const result = mod.default(options);
+  if (!isPlugin(result)) {
+    return yield* Effect.fail(new LazyPluginError({
+      context: {
+        id,
+        reason: "invalid-plugin"
+      }
+    }));
+  }
+  if (result.meta.id !== id) {
+    return yield* Effect.fail(new LazyPluginError({
+      context: {
+        id,
+        reason: "meta-mismatch",
+        returnedId: result.meta.id
+      }
+    }));
+  }
+  return result;
+});
+
+export {
+  Service,
+  activate,
+  reset,
+  shutdown,
+  PluginModuleTypeId,
+  isPluginModule,
+  PluginTypeId,
+  isPlugin,
+  define,
+  addModule,
+  make,
+  lazy,
+  isLazy,
+  LazyPluginError,
+  resolveLazy,
+  plugin_exports
+};
+//# sourceMappingURL=chunk-HTBJU5FX.mjs.map

package/dist/lib/node-esm/chunk-HTBJU5FX.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/core/plugin.ts"],
+  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Context from 'effect/Context';\nimport * as Effect from 'effect/Effect';\nimport * as Option from 'effect/Option';\nimport * as Pipeable from 'effect/Pipeable';\n\nimport { BaseError } from '@dxos/errors';\nimport { invariant } from '@dxos/invariant';\n\nimport type * as ActivationEvent from './activation-event';\nimport * as Capability from './capability';\nimport type * as PluginManager from './plugin-manager';\n\n//\n// Plugin Service Layer\n//\n\n/**\n * Effect Context.Tag for accessing PluginManager via the Effect layer system.\n * This allows lifecycle operations to access the plugin manager without having it passed as an argument.\n */\nexport class Service extends Context.Tag('@dxos/app-framework/PluginManager')<Service, PluginManager.PluginManager>() {}\n\n//\n// Lifecycle Functions\n//\n\n/**\n * Activates plugins based on the activation event.\n * Accesses the PluginManager via the Effect layer system.\n * @param event The activation event.\n * @returns Whether the activation was successful.\n */\nexport const activate = (event: ActivationEvent.ActivationEvent): Effect.Effect<boolean, Error, Service> =>\n  Effect.flatMap(Service, (manager) => manager.activate(event));\n\n/**\n * Re-activates the modules that were activated by the event.\n * Accesses the PluginManager via the Effect layer system.\n * @param event The activation event.\n * @returns Whether the reset was successful.\n */\nexport const reset = (event: ActivationEvent.ActivationEvent): Effect.Effect<boolean, Error, Service> =>\n  Effect.flatMap(Service, (manager) => manager.reset(event));\n\n/**\n * Shuts down the plugin manager, deactivating all active modules and clearing lifecycle state.\n * Accesses the PluginManager via the Effect layer system.\n */\nexport const shutdown = (): Effect.Effect<boolean, Error, Service> =>\n  Effect.flatMap(Service, (manager) => manager.shutdown());\n\n/**\n * Computes a module ID from plugin ID and export name.\n */\nconst computeModuleId = (pluginId: string, moduleName: string): string => {\n  return `${pluginId}.module.${moduleName}`;\n};\n\n/**\n * Identifier denoting a PluginModule.\n */\nexport const PluginModuleTypeId: unique symbol = Symbol.for('@dxos/app-framework/PluginModule');\nexport type PluginModuleTypeId = typeof PluginModuleTypeId;\n\n/**\n * Type guard to check if a value is a PluginModule.\n */\nexport const isPluginModule = (value: unknown): value is PluginModule => {\n  return typeof value === 'object' && value !== null && PluginModuleTypeId in value;\n};\n\n/**\n * A unit of containment of modular functionality that can be provided to an application.\n * Activation of a module is async allowing for code to split and loaded lazily.\n */\nexport interface PluginModule {\n  readonly [PluginModuleTypeId]: PluginModuleTypeId;\n  /**\n   * Unique id of the module.\n   */\n  id: string;\n\n  /**\n   * Events for which the module will be activated.\n   */\n  activatesOn: ActivationEvent.Events;\n\n  /**\n   * Events that this module fires *before* its own activation runs.\n   *\n   * When this module is asked to activate (via {@link activatesOn}), the\n   * plugin manager first activates every event listed here, ensuring any\n   * other modules that contribute to those events have completed before\n   * this module's {@link activate} body executes. These events are fired\n   * by the framework on this module's behalf — the module does not need\n   * to wait for some other code to fire them.\n   *\n   * The module is marked as needing reset if a module activated by one\n   * of these events is later removed.\n   *\n   * Read as: \"this module fires these events before [its] activation\".\n   */\n  firesBeforeActivation?: ActivationEvent.ActivationEvent[];\n\n  /**\n   * Events that this module fires *after* its own activation completes.\n   *\n   * Once this module's {@link activate} body has finished executing, the\n   * plugin manager activates every event listed here, causing any modules\n   * listening on those events to run. These events are fired by the\n   * framework on this module's behalf as part of this module's lifecycle.\n   *\n   * Read as: \"this module fires these events after [its] activation\".\n   */\n  firesAfterActivation?: ActivationEvent.ActivationEvent[];\n\n  /**\n   * Called when the module is activated.\n   * CapabilityManager is accessed via the Effect layer system (Capability.Service).\n   * PluginManager is accessed via Plugin.Service.\n   * @param props Optional props passed to the module.\n   * @returns The capabilities of the module.\n   */\n  activate: (props?: any) => Effect.Effect<Capability.ModuleReturn, Error, Capability.Service | Service | never>;\n}\n\nexport type PluginModuleOptions = Omit<PluginModule, 'id' | typeof PluginModuleTypeId> & { id?: string };\n\nclass PluginModuleImpl implements PluginModule {\n  readonly [PluginModuleTypeId]: PluginModuleTypeId = PluginModuleTypeId;\n  readonly id: PluginModule['id'];\n  readonly activatesOn: PluginModule['activatesOn'];\n  readonly firesBeforeActivation?: PluginModule['firesBeforeActivation'];\n  readonly firesAfterActivation?: PluginModule['firesAfterActivation'];\n  readonly activate: PluginModule['activate'];\n\n  constructor(options: Omit<PluginModule, typeof PluginModuleTypeId>) {\n    this.id = options.id;\n    this.activatesOn = options.activatesOn;\n    this.firesBeforeActivation = options.firesBeforeActivation;\n    this.firesAfterActivation = options.firesAfterActivation;\n    this.activate = options.activate;\n  }\n}\n\nexport type Meta = {\n  /**\n   * Globally unique ID.\n   *\n   * Expected to be in the form of a valid URL.\n   *\n   * @example org.dxos.plugin.example\n   */\n  id: string;\n\n  /**\n   * Human-readable name.\n   */\n  name: string;\n\n  /**\n   * Short description of plugin functionality.\n   */\n  description?: string;\n\n  /**\n   * Name of the author or organization that created the plugin.\n   */\n  author?: string;\n\n  /**\n   * URL of home page.\n   */\n  homePage?: string;\n\n  /**\n   * URL of source code.\n   */\n  source?: string;\n\n  /**\n   * URL of screenshot.\n   */\n  screenshots?: string[];\n\n  /**\n   * Tags to help categorize the plugin.\n   */\n  tags?: string[];\n\n  /**\n   * A grep-able symbol string which can be resolved to an icon asset by @ch-ui/icons, via @ch-ui/vite-plugin-icons.\n   */\n  icon?: string;\n\n  /**\n   * Icon hue (ChromaticPalette).\n   */\n  iconHue?: string;\n};\n\n/**\n * Identifier denoting a Plugin.\n */\nexport const PluginTypeId: unique symbol = Symbol.for('@dxos/app-framework/Plugin');\nexport type PluginTypeId = typeof PluginTypeId;\n\n/**\n * Type guard to check if a value is a Plugin.\n */\nexport const isPlugin = (value: unknown): value is Plugin => {\n  return typeof value === 'object' && value !== null && PluginTypeId in value;\n};\n\n/**\n * A collection of modules that are be enabled/disabled as a unit.\n * Plugins provide things such as components, state, actions, etc. to the application.\n */\n// TODO(burdon): Convert to ECHO schema.\nexport interface Plugin {\n  readonly [PluginTypeId]: PluginTypeId;\n  readonly meta: Readonly<Meta>;\n  readonly modules: ReadonlyArray<PluginModule>;\n}\n\n/**\n * Internal implementation of Plugin.\n * @internal\n */\nclass PluginImpl implements Plugin {\n  readonly [PluginTypeId]: PluginTypeId = PluginTypeId;\n\n  constructor(\n    private readonly _meta: Meta,\n    private readonly _modules: PluginModule[],\n  ) {}\n\n  get meta(): Readonly<Meta> {\n    return this._meta;\n  }\n\n  get modules(): ReadonlyArray<PluginModule> {\n    return this._modules;\n  }\n}\n\n/**\n * Builder interface for creating plugins incrementally.\n */\nexport interface PluginBuilder<T = void> extends Pipeable.Pipeable {\n  readonly meta: Meta;\n  readonly modules: ReadonlyArray<PluginModuleOptions | ((options: T) => PluginModuleOptions)>;\n  addModule(moduleOptions: PluginModuleOptions | ((options: T) => PluginModuleOptions)): PluginBuilder<T>;\n}\n\n/**\n * Builder implementation for creating plugins incrementally.\n */\nclass PluginBuilderImpl<T = void> implements PluginBuilder<T> {\n  readonly meta: Meta;\n  private readonly _modules: Array<PluginModuleOptions | ((options: T) => PluginModuleOptions)> = [];\n\n  constructor(meta: Meta) {\n    this.meta = meta;\n  }\n\n  get modules(): ReadonlyArray<PluginModuleOptions | ((options: T) => PluginModuleOptions)> {\n    return this._modules;\n  }\n\n  addModule(moduleOptions: PluginModuleOptions | ((options: T) => PluginModuleOptions)): PluginBuilder<T> {\n    this._modules.push(moduleOptions);\n    return this;\n  }\n\n  pipe() {\n    // eslint-disable-next-line prefer-rest-params\n    return Pipeable.pipeArguments(this, arguments);\n  }\n}\n\n/**\n * Creates a new PluginBuilder to start building a plugin.\n */\nexport const define = <T = void>(meta: Meta): PluginBuilder<T> => new PluginBuilderImpl<T>(meta);\n\n/**\n * Adds a module to a plugin builder.\n * Supports both pipeline and direct call styles.\n * Modules can be either PluginModuleOptions or functions that receive options.\n */\nexport function addModule<T>(\n  moduleOptions: PluginModuleOptions | ((options: T) => PluginModuleOptions),\n): (builder: PluginBuilder<T>) => PluginBuilder<T>;\nexport function addModule<T>(\n  builder: PluginBuilder<T>,\n  moduleOptions: PluginModuleOptions | ((options: T) => PluginModuleOptions),\n): PluginBuilder<T>;\nexport function addModule<T>(\n  moduleOptionsOrBuilder: PluginModuleOptions | ((options: T) => PluginModuleOptions) | PluginBuilder<T>,\n  moduleOptions?: PluginModuleOptions | ((options: T) => PluginModuleOptions),\n): ((builder: PluginBuilder<T>) => PluginBuilder<T>) | PluginBuilder<T> {\n  // If second arg is provided, it's the direct call style: addModule(builder, moduleOptions)\n  if (moduleOptions !== undefined) {\n    return (moduleOptionsOrBuilder as PluginBuilder<T>).addModule(moduleOptions);\n  }\n  // Otherwise it's pipeline style: addModule(moduleOptions) returns a function\n  const moduleOpts = moduleOptionsOrBuilder as PluginModuleOptions | ((options: T) => PluginModuleOptions);\n  return (builder: PluginBuilder<T>) => builder.addModule(moduleOpts);\n}\n\nexport type PluginFactory<T = void> = ((options: T) => Plugin) & { meta: Meta };\n\n/**\n * Resolves a module from either PluginModuleOptions or a function that returns PluginModuleOptions.\n */\nconst resolveModule = (\n  meta: Meta,\n  module: PluginModuleOptions | ((options: any) => PluginModuleOptions),\n  options?: any,\n): PluginModuleImpl => {\n  const moduleOptions = typeof module === 'function' ? module(options) : module;\n  const id = Option.fromNullable(moduleOptions.id).pipe(\n    Option.match({\n      onNone: () => {\n        const exportName = Capability.getModuleTag(moduleOptions.activate);\n        invariant(exportName, `Plugin module missing name. Plugin: ${meta.id}`);\n        return computeModuleId(meta.id, exportName);\n      },\n      onSome: (id) => computeModuleId(meta.id, id),\n    }),\n  );\n  return new PluginModuleImpl({ ...moduleOptions, id });\n};\n\n/**\n * Creates a Plugin from a builder.\n * Supports both pipeline and direct call styles.\n * Always returns a factory function (options: T) => Plugin.\n * When T is void, the function takes no arguments: () => Plugin.\n */\nexport function make<T>(builder: PluginBuilder<T>): PluginFactory<T>;\nexport function make<T>(builder: PluginBuilder<T>): PluginFactory<T> {\n  const meta = builder.meta;\n\n  const factory = (options: T) => {\n    const modules = builder.modules.map((module) => resolveModule(meta, module, options));\n    return new PluginImpl(meta, modules);\n  };\n\n  return Object.assign(factory, { meta });\n}\n\n//\n// Lazy plugin loading\n//\n\n/**\n * Symbol used to tag lazy plugin stubs with their loader closure.\n * Hidden from enumeration so plugin manager iteration / serialization paths\n * don't trip over it.\n */\nconst LazyTag: unique symbol = Symbol.for('@dxos/app-framework/Plugin/Lazy');\n\n/**\n * Async loader for a lazy plugin's real implementation.\n * The default export of the loaded module must be a `PluginFactory<T>` —\n * i.e. the same shape `Plugin.make` produces.\n */\nexport type LazyLoader<T = void> = () => Promise<{ default: PluginFactory<T> }>;\n\n/** Internal: payload carried on a lazy stub. */\ntype LazyPayload = { loader: LazyLoader<any>; options: unknown };\n\n/**\n * Defines a lazy plugin whose body is loaded on first enable.\n *\n * The returned factory produces a stub `Plugin` that exposes `meta`\n * synchronously (so callers can read `Plugin.meta.id` for free) but defers\n * loading the real plugin's modules until the manager calls\n * `Plugin.resolveLazy`. This lets the plugin's main entry point ship as a\n * tiny meta-only chunk — the heavy capabilities, schema, React surfaces,\n * etc. live behind the dynamic `import()` and become a separate Rollup\n * chunk that is only fetched when the plugin is enabled.\n *\n * @example\n * ```ts\n * // plugin-markdown/src/index.ts\n * import { Plugin } from '@dxos/app-framework';\n * import { meta } from './meta';\n *\n * export const MarkdownPlugin = Plugin.lazy(meta, () => import('./MarkdownPlugin'));\n *\n * // plugin-markdown/src/MarkdownPlugin.tsx\n * export const MarkdownPlugin = Plugin.define(meta).pipe(...heavy modules..., Plugin.make);\n * export default MarkdownPlugin;\n * ```\n */\nexport const lazy = <T = void>(meta: Meta, loader: LazyLoader<T>): PluginFactory<T> => {\n  const factory = (options: T): Plugin => {\n    const stub = new PluginImpl(meta, []);\n    Object.defineProperty(stub, LazyTag, {\n      value: { loader, options } satisfies LazyPayload,\n      enumerable: false,\n    });\n    return stub;\n  };\n  return Object.assign(factory, { meta });\n};\n\n/**\n * Type guard for lazy plugin stubs produced by {@link lazy}.\n */\nexport const isLazy = (plugin: Plugin): boolean => LazyTag in plugin;\n\n/**\n * Tagged error for failures during lazy plugin resolution. `context.id` is\n * the lazy plugin's `meta.id`; `context.reason` discriminates the failure\n * mode (`'load-failed' | 'missing-default' | 'invalid-plugin' |\n * 'meta-mismatch'`) so callers can route on it.\n */\nexport class LazyPluginError extends BaseError.extend('LazyPluginError', 'Failed to resolve lazy plugin') {}\n\n/**\n * Resolves a lazy plugin stub to its real plugin.\n * Returns the plugin unchanged if it is not lazy. Failures surface as\n * {@link LazyPluginError} with `context.reason` indicating the failure mode\n * and (for loader failures) `cause` set to the original error.\n */\nexport const resolveLazy = (plugin: Plugin): Effect.Effect<Plugin, LazyPluginError> =>\n  Effect.gen(function* () {\n    if (!isLazy(plugin)) {\n      return plugin;\n    }\n    const id = plugin.meta.id;\n    const { loader, options } = (plugin as unknown as { [LazyTag]: LazyPayload })[LazyTag];\n    const mod = yield* Effect.tryPromise({\n      try: loader,\n      catch: (error) => new LazyPluginError({ context: { id, reason: 'load-failed' }, cause: error }),\n    });\n    if (!mod || typeof mod.default !== 'function') {\n      return yield* Effect.fail(new LazyPluginError({ context: { id, reason: 'missing-default' } }));\n    }\n    const result = mod.default(options);\n    if (!isPlugin(result)) {\n      return yield* Effect.fail(new LazyPluginError({ context: { id, reason: 'invalid-plugin' } }));\n    }\n    if (result.meta.id !== id) {\n      return yield* Effect.fail(\n        new LazyPluginError({ context: { id, reason: 'meta-mismatch', returnedId: result.meta.id } }),\n      );\n    }\n    return result;\n  });\n"],
+  "mappings": ";;;;;;;;;AAAA;;;;;;;;;;;;;;;;;;AAIA,YAAYA,aAAa;AACzB,YAAYC,YAAY;AACxB,YAAYC,YAAY;AACxB,YAAYC,cAAc;AAE1B,SAASC,iBAAiB;AAC1B,SAASC,iBAAiB;AAM1B,IAAE,eAAA;AAUA,IAAA,UAAA,cAAA,YAAA,mCAAA,EAAA,EAAA;AACF;;;;AAiCA,IAAA,kBAAA,CAAA,UAAA,eAAA;AAEA,SAAA,GAAA,QAAA,WAAA,UAAA;;;AAWE,IAAA,iBAAA,CAAA,UAAA;AA2DF,SAAMC,OAAAA,UAAAA,YAAAA,UAAAA,QAAAA,sBAAAA;;IAEKC,yBAAuB;EACvBC,CAAAA,kBAAyC,IAAA;EACzCC;EACAC;EACAC;EAET;;cAEOH,SAAW;AAChB,SAAKC,KAAAA,QAAAA;AACL,SAAKC,cAAAA,QAAoB;AACzB,SAAKC,wBAAmBA,QAAQ;AAClC,SAAA,uBAAA,QAAA;AACF,SAAA,WAAA,QAAA;EA0DA;;;AAWE,IAAA,WAAA,CAAA,UAAA;AAaF,SAAA,OAAA,UAAA,YAAA,UAAA,QAAA,gBAAA;;;EAKW;EAET;eACmBC,IAAAA;cACAC,OAAAA,UAAAA;AAChB,SAAA,QAAA;AAECC,SAAAA,WAAuB;;EAE3B,IAAA,OAAA;AAEIC,WAAAA,KAAuC;;EAE3C,IAAA,UAAA;AACF,WAAA,KAAA;EAWA;;AAKmBF,IAAAA,oBAAAA,MAAkF;EAEnG;aACOC,CAAAA;EACP,YAAA,MAAA;AAEIC,SAAAA,OAAsF;;EAE1F,IAAA,UAAA;AAEAC,WAAUC,KAAAA;;YAER,eAAW;AACb,SAAA,SAAA,KAAA,aAAA;AAEAC,WAAO;;SAEL;AAEJ,WAAA,uBAAA,MAAA,SAAA;EAEA;;AAqBE,IAAA,SAAA,CAAA,SAAA,IAAA,kBAAA,IAAA;AACA,SAAID,UAAkBE,wBAAW,eAAA;AAEjC,MAAA,kBAAA,QAAA;AACA,WAAA,uBAAA,UAAA,aAAA;EACA;AAEF,QAAA,aAAA;AAIA,SAAA,CAAA,YAAA,QAAA,UAAA,UAAA;;AASE,IAAMZ,gBAAYa,CAAAA,MAAAA,QAAaH,YAAgB;QAE3CI,gBAAQ,OAAA,WAAA,aAAA,OAAA,OAAA,IAAA;aACAC,oBAAaC,cAAWC,EAAAA,EAAAA,KAAaP,aAAcN;YACzDc,MAAAA;AACA,YAAA,aAA8B,aAAEH,cAAAA,QAAAA;AAClC,gBAAA,YAAA,uCAAA,KAAA,EAAA,IAAA,EAAA,YAAA,YAAA,GAAA,cAAA,GAAA,KAAA,GAAA,QAAA,GAAA,CAAA,cAAA,kDAAA,EAAA,CAAA;AACAI,aAASnB,gBAAOoB,KAAgBb,IAAKP,UAAIA;IAC3C;IAEF,QAAWD,CAAAA,QAAAA,gBAAiB,KAAA,IAAAC,GAAA;;SAAoBA,IAAAA,iBAAAA;IAAG,GAAA;IACrD;EASA,CAAA;;AAGE,SAAMqB,KAAWC,SAAAA;QACf,OAAMd,QAAUe;QAChB,UAAWC,CAAAA,YAAWjB;AACxB,UAAA,UAAA,QAAA,QAAA,IAAA,CAAA,WAAA,cAAA,MAAA,QAAA,OAAA,CAAA;AAEA,WAAOkB,IAAOC,WAAOL,MAAS,OAAA;;AAAO,SAAA,OAAA,OAAA,SAAA;IACvC;EAEE,CAAA;AACF;;AA8CI,IAAMM,OAAO,CAAIH,MAAAA,WAAWjB;QAC5BkB,UAAOG,CAAAA,YAAeD;UACpBE,OAAO,IAAA,WAAA,MAAA,CAAA,CAAA;0BAAEC,MAAAA,SAAAA;aAAQR;QAAQ;QACzBS;MACF;MACA,YAAOJ;IACT,CAAA;AACA,WAAOF;;AAA8B,SAAA,OAAA,OAAA,SAAA;IACrC;EAEF,CAAA;;;AAaA,IAAA,kBAAA,cAAA,UAAA,OAAA,mBAAA,+BAAA,EAAA;;IASM,cAAOO,CAAAA,WAAAA,WAAAA,aAAAA;AACT,MAAA,CAAA,OAAA,MAAA,GAAA;AACA,WAAWA;EACX;AACA,QAAMC,KAAAA,OAAM,KAAOC;QACjBC,EAAAA,QAAKL,QAAAA,IAAAA,OAAAA,OAAAA;QACLM,MAAQC,OAAcC,kBAAAA;;sBAA6BtC,IAAAA,gBAAAA;eAAIuC;QAAsB;QAAGC,QAAOH;MAAM;MAC/F,OAAA;IACKJ,CAAAA;;cAC6CQ,OAAS,IAAA,YAAA,YAAA;kBAAEzC,YAAAA,IAAAA,gBAAAA;eAAIuC;QAA0B;QAAE,QAAA;MAC7F;IACA,CAAA,CAAMG;EACN;QACE,SAAO,IAAOR,QAAOS,OAASL;gBAAkBG,MAAS,GAAA;kBAAEzC,YAAAA,IAAAA,gBAAAA;eAAIuC;QAAyB;QAAE,QAAA;MAC5F;IACIG,CAAAA,CAAAA;;aAEsBD,KAAAA,OAAS,IAAA;kBAAEzC,YAAAA,IAAAA,gBAAAA;eAAIuC;QAAyBK;QAA2B,QAAA;QAAE,YAAA,OAAA,KAAA;MAE/F;IACA,CAAA,CAAA;EACC;;;",
+  "names": ["Context", "Effect", "Option", "Pipeable", "BaseError", "invariant", "PluginModuleImpl", "id", "activatesOn", "firesBeforeActivation", "firesAfterActivation", "activate", "_meta", "_modules", "meta", "modules", "addModule", "moduleOptions", "pipe", "undefined", "fromNullable", "onNone", "exportName", "Capability", "getModuleTag", "invariant", "onSome", "computeModuleId", "factory", "options", "builder", "PluginImpl", "Object", "assign", "stub", "defineProperty", "value", "loader", "enumerable", "plugin", "mod", "Effect", "try", "catch", "error", "LazyPluginError", "reason", "cause", "context", "result", "fail", "returnedId"]
+}

package/dist/lib/node-esm/chunk-M3HKPRPO.mjs

@@ -0,0 +1,423 @@
+import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
+import {
+  isPlugin
+} from "./chunk-HTBJU5FX.mjs";
+import {
+  __export
+} from "./chunk-HSLMI22Q.mjs";
+
+// src/core/url-loader.ts
+var url_loader_exports = {};
+__export(url_loader_exports, {
+  RemotePluginLoadError: () => RemotePluginLoadError,
+  getInstalledVersion: () => getInstalledVersion,
+  getRemoteEntries: () => getRemoteEntries,
+  isLocalUrl: () => isLocalUrl,
+  make: () => make,
+  preload: () => preload,
+  setInstalledVersion: () => setInstalledVersion,
+  uninstall: () => uninstall
+});
+import * as Effect3 from "effect/Effect";
+import * as Option from "effect/Option";
+import { BaseError as BaseError3 } from "@dxos/errors";
+import { log } from "@dxos/log";
+
+// src/core/plugin-asset-cache.ts
+var plugin_asset_cache_exports = {};
+__export(plugin_asset_cache_exports, {
+  PluginAssetCacheError: () => PluginAssetCacheError,
+  noop: () => noop
+});
+import * as Effect from "effect/Effect";
+import { BaseError } from "@dxos/errors";
+var PluginAssetCacheError = class extends BaseError.extend("PluginAssetCacheError", "Plugin asset cache operation failed") {
+};
+var noop = () => ({
+  cache: () => Effect.void,
+  evict: () => Effect.void,
+  resolve: (_pluginId, url) => Effect.succeed(url),
+  list: () => Effect.succeed([])
+});
+
+// src/core/plugin-manifest.ts
+var plugin_manifest_exports = {};
+__export(plugin_manifest_exports, {
+  Manifest: () => Manifest,
+  PLUGIN_DEV_SERVER_PORT: () => PLUGIN_DEV_SERVER_PORT,
+  PluginManifestError: () => PluginManifestError,
+  fetchManifest: () => fetchManifest,
+  parse: () => parse
+});
+import * as FetchHttpClient from "@effect/platform/FetchHttpClient";
+import * as HttpClient from "@effect/platform/HttpClient";
+import * as HttpClientRequest from "@effect/platform/HttpClientRequest";
+import * as HttpClientResponse from "@effect/platform/HttpClientResponse";
+import * as Effect2 from "effect/Effect";
+import * as Schema from "effect/Schema";
+import { BaseError as BaseError2 } from "@dxos/errors";
+import { PLUGIN_ENTRY_FILENAME } from "@dxos/protocols";
+var PLUGIN_DEV_SERVER_PORT = 3967;
+var PluginManifestError = class extends BaseError2.extend("PluginManifestError", "Plugin manifest is invalid") {
+};
+var Manifest = Schema.Struct({
+  id: Schema.String,
+  name: Schema.String,
+  version: Schema.String,
+  assets: Schema.Array(Schema.String),
+  devEntry: Schema.String.pipe(Schema.optional)
+});
+var resolve = (manifestUrl, manifest) => {
+  const dev = manifest.devEntry !== void 0;
+  return {
+    id: manifest.id,
+    name: manifest.name,
+    version: manifest.version,
+    entryUrl: new URL(dev ? manifest.devEntry : PLUGIN_ENTRY_FILENAME, manifestUrl).toString(),
+    assetUrls: manifest.assets.map((asset) => new URL(asset, manifestUrl).toString()),
+    dev
+  };
+};
+var parse = (manifestUrl, payload) => {
+  const manifest = Schema.decodeUnknownSync(Manifest)(payload);
+  if (manifest.devEntry === void 0 && !manifest.assets.includes(PLUGIN_ENTRY_FILENAME)) {
+    throw new Error(`Manifest at ${manifestUrl} does not list ${PLUGIN_ENTRY_FILENAME} in assets.`);
+  }
+  return resolve(manifestUrl, manifest);
+};
+var fetchManifest = (manifestUrl) => Effect2.gen(function* () {
+  const response = yield* HttpClientRequest.get(manifestUrl).pipe(HttpClient.execute, Effect2.mapError((cause) => new PluginManifestError({
+    context: {
+      manifestUrl,
+      reason: "fetch-failed"
+    },
+    cause
+  })));
+  if (response.status >= 400) {
+    return yield* Effect2.fail(new PluginManifestError({
+      context: {
+        manifestUrl,
+        reason: "http-error",
+        status: response.status
+      }
+    }));
+  }
+  const manifest = yield* HttpClientResponse.schemaBodyJson(Manifest)(response).pipe(Effect2.mapError((cause) => new PluginManifestError({
+    context: {
+      manifestUrl,
+      reason: "parse-failed"
+    },
+    cause
+  })));
+  if (manifest.devEntry === void 0 && !manifest.assets.includes(PLUGIN_ENTRY_FILENAME)) {
+    return yield* Effect2.fail(new PluginManifestError({
+      context: {
+        manifestUrl,
+        reason: "invalid"
+      },
+      cause: `assets does not include ${PLUGIN_ENTRY_FILENAME}`
+    }));
+  }
+  return resolve(manifestUrl, manifest);
+}).pipe(Effect2.scoped, Effect2.provide(FetchHttpClient.layer));
+
+// src/core/url-loader.ts
+var __dxlog_file = "/__w/dxos/dxos/packages/sdk/app-framework/src/core/url-loader.ts";
+var DEFAULT_KEY = "org.dxos.composer.remote-plugins";
+var RemotePluginLoadError = class extends BaseError3.extend("RemotePluginLoadError", "Failed to load remote plugin") {
+};
+var defaultStorage = () => ({
+  get: (key) => localStorage.getItem(key),
+  set: (key, value) => localStorage.setItem(key, value)
+});
+var getPersistedRemotePlugins = (storage, key) => {
+  try {
+    const parsed = JSON.parse(storage.get(key) ?? "[]");
+    if (!Array.isArray(parsed)) {
+      return [];
+    }
+    return parsed.filter((entry) => typeof entry === "object" && entry !== null && typeof entry.id === "string" && typeof entry.url === "string");
+  } catch {
+    return [];
+  }
+};
+var persistRemotePlugin = (storage, key, entry) => {
+  try {
+    const entries = getPersistedRemotePlugins(storage, key).filter((existing) => existing.id !== entry.id);
+    entries.push(entry);
+    storage.set(key, JSON.stringify(entries));
+  } catch (error) {
+    log.warn("failed to persist remote plugin entry", {
+      entry,
+      error
+    }, { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 40, S: void 0 });
+  }
+};
+var removePersistedRemotePlugin = (storage, key, pluginId) => {
+  try {
+    const entries = getPersistedRemotePlugins(storage, key).filter((existing) => existing.id !== pluginId);
+    storage.set(key, JSON.stringify(entries));
+  } catch (error) {
+    log.warn("failed to remove remote plugin entry", {
+      pluginId,
+      error
+    }, { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 51, S: void 0 });
+  }
+};
+var isUrl = (locator) => {
+  try {
+    const url = new URL(locator);
+    return url.protocol === "http:" || url.protocol === "https:";
+  } catch {
+    return false;
+  }
+};
+var isLocalUrl = (locator) => {
+  try {
+    const hostname = new URL(locator).hostname.toLowerCase();
+    return hostname === "localhost" || hostname === "127.0.0.1" || hostname === "::1" || hostname === "[::1]";
+  } catch {
+    return false;
+  }
+};
+var getRemoteEntries = (options = {}) => {
+  const storage = options.storage ?? defaultStorage();
+  const key = options.key ?? DEFAULT_KEY;
+  return getPersistedRemotePlugins(storage, key);
+};
+var setInstalledVersion = (id, version, options = {}) => {
+  const storage = options.storage ?? defaultStorage();
+  const key = options.key ?? DEFAULT_KEY;
+  const entries = getPersistedRemotePlugins(storage, key);
+  const index = entries.findIndex((entry) => entry.id === id);
+  if (index === -1) {
+    return;
+  }
+  entries[index] = {
+    ...entries[index],
+    version
+  };
+  try {
+    storage.set(key, JSON.stringify(entries));
+  } catch (error) {
+    log.warn("failed to update installed version for remote plugin", {
+      id,
+      version,
+      error
+    }, { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 103, S: void 0 });
+  }
+};
+var getInstalledVersion = (id, options = {}) => {
+  const storage = options.storage ?? defaultStorage();
+  const key = options.key ?? DEFAULT_KEY;
+  return getPersistedRemotePlugins(storage, key).find((entry) => entry.id === id)?.version;
+};
+var normalizePluginExport = (mod) => {
+  const exported = mod.default;
+  if (isPlugin(exported)) {
+    return exported;
+  }
+  if (typeof exported === "function") {
+    const result = exported();
+    if (isPlugin(result)) {
+      return result;
+    }
+  }
+  throw new Error("Remote module default export is not a Plugin or a zero-arg plugin factory.");
+};
+var loadStylesheets = (manifest, cache) => Effect3.gen(function* () {
+  if (typeof document === "undefined") {
+    return;
+  }
+  const cssUrls = manifest.assetUrls.filter((url) => url.endsWith(".css"));
+  for (const url of cssUrls) {
+    const resolved = yield* cache.resolve(manifest.id, url);
+    if (document.querySelector(`link[data-dxos-plugin-id="${manifest.id}"][href="${resolved}"]`)) {
+      continue;
+    }
+    const link = document.createElement("link");
+    link.rel = "stylesheet";
+    link.href = resolved;
+    link.dataset.dxosPluginId = manifest.id;
+    document.head.appendChild(link);
+  }
+});
+var loadFromManifest = (manifestUrl, cache) => Effect3.gen(function* () {
+  log.info("loading remote plugin", {
+    manifestUrl
+  }, { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 152, S: this });
+  const manifest = yield* fetchManifest(manifestUrl).pipe(Effect3.mapError((cause) => new RemotePluginLoadError({
+    context: {
+      locator: manifestUrl,
+      reason: "manifest-error"
+    },
+    cause
+  })));
+  const wrapCacheError = Effect3.mapError((cause) => new RemotePluginLoadError({
+    context: {
+      locator: manifestUrl,
+      reason: "cache-error"
+    },
+    cause
+  }));
+  if (!manifest.dev) {
+    const cachedUrls = manifest.assetUrls.indexOf(manifestUrl) === -1 ? [
+      manifestUrl,
+      ...manifest.assetUrls
+    ] : manifest.assetUrls;
+    yield* cache.cache(manifest.id, cachedUrls).pipe(wrapCacheError);
+  }
+  const entryUrl = manifest.dev ? manifest.entryUrl : yield* cache.resolve(manifest.id, manifest.entryUrl).pipe(wrapCacheError);
+  const mod = yield* Effect3.tryPromise({
+    try: () => import(
+      /* @vite-ignore */
+      entryUrl
+    ),
+    catch: (cause) => new RemotePluginLoadError({
+      context: {
+        locator: manifestUrl,
+        reason: "import-failed"
+      },
+      cause
+    })
+  });
+  const plugin = normalizePluginExport(mod);
+  if (!plugin.meta.id || !plugin.meta.name) {
+    return yield* Effect3.fail(new RemotePluginLoadError({
+      context: {
+        locator: manifestUrl,
+        reason: "meta-missing"
+      }
+    }));
+  }
+  if (plugin.meta.id !== manifest.id) {
+    return yield* Effect3.fail(new RemotePluginLoadError({
+      context: {
+        locator: manifestUrl,
+        reason: "meta-mismatch",
+        metaId: plugin.meta.id,
+        manifestId: manifest.id
+      }
+    }));
+  }
+  if (!manifest.dev) {
+    yield* loadStylesheets(manifest, cache).pipe(wrapCacheError);
+  }
+  return {
+    plugin,
+    manifest
+  };
+});
+var preload = (options = {}) => Effect3.gen(function* () {
+  const storage = options.storage ?? defaultStorage();
+  const key = options.key ?? DEFAULT_KEY;
+  const cache = options.cache ?? noop();
+  const onPluginLoaded = options.onPluginLoaded;
+  const entries = getPersistedRemotePlugins(storage, key);
+  if (entries.length === 0) {
+    return [];
+  }
+  log.info("preloading remote plugins", {
+    count: entries.length
+  }, { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 240, S: this });
+  const total = entries.length;
+  let loaded = 0;
+  const results = yield* Effect3.all(entries.map((entry) => loadFromManifest(entry.url, cache).pipe(
+    Effect3.tapError((error) => Effect3.sync(() => log.warn("failed to preload remote plugin", {
+      entry,
+      error
+    }, { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 245, S: this }))),
+    Effect3.option,
+    // Tick the progress hook on both success and recoverable failure so
+    // the counter monotonically reaches `total`. The host-supplied
+    // callback is best-effort: any synchronous throw flows through
+    // `Effect.try` and gets logged + ignored so a buggy hook can't
+    // derail the preload.
+    Effect3.tap(() => Effect3.sync(() => {
+      loaded += 1;
+    }).pipe(Effect3.andThen(Effect3.try(() => onPluginLoaded?.(loaded, total))), Effect3.tapError((error) => Effect3.sync(() => log.warn("onPluginLoaded threw", {
+      loaded,
+      total,
+      error
+    }, { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 255, S: this }))), Effect3.ignore))
+  )), {
+    concurrency: "unbounded"
+  });
+  return results.flatMap((result) => Option.match(result, {
+    onNone: () => [],
+    onSome: ({ plugin }) => [
+      plugin
+    ]
+  }));
+});
+var make = (builtinPlugins, options = {}) => {
+  const storage = options.storage ?? defaultStorage();
+  const key = options.key ?? DEFAULT_KEY;
+  const cache = options.cache ?? noop();
+  return (locator) => Effect3.gen(function* () {
+    const builtin = builtinPlugins.find((plugin2) => plugin2.meta.id === locator);
+    if (builtin) {
+      return {
+        plugin: builtin
+      };
+    }
+    if (!isUrl(locator)) {
+      return yield* Effect3.fail(new RemotePluginLoadError({
+        context: {
+          locator,
+          reason: "invalid-locator"
+        }
+      }));
+    }
+    const { plugin, manifest } = yield* loadFromManifest(locator, cache);
+    if (!manifest.dev) {
+      const duplicate = builtinPlugins.find((existing) => existing.meta.id === plugin.meta.id);
+      if (duplicate) {
+        return yield* Effect3.fail(new RemotePluginLoadError({
+          context: {
+            locator,
+            reason: "duplicate-id",
+            id: plugin.meta.id
+          }
+        }));
+      }
+      persistRemotePlugin(storage, key, {
+        id: plugin.meta.id,
+        url: locator
+      });
+    }
+    return {
+      plugin,
+      dev: manifest.dev
+    };
+  });
+};
+var uninstall = (pluginId, options = {}) => Effect3.gen(function* () {
+  const storage = options.storage ?? defaultStorage();
+  const key = options.key ?? DEFAULT_KEY;
+  const cache = options.cache ?? noop();
+  removePersistedRemotePlugin(storage, key, pluginId);
+  if (typeof document !== "undefined") {
+    document.querySelectorAll(`link[data-dxos-plugin-id="${pluginId}"]`).forEach((node) => node.remove());
+  }
+  yield* cache.evict(pluginId).pipe(Effect3.tapError((error) => Effect3.sync(() => log.warn("failed to evict plugin assets", {
+    pluginId,
+    error
+  }, { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 337, S: this }))), Effect3.ignore);
+});
+
+export {
+  plugin_asset_cache_exports,
+  PLUGIN_DEV_SERVER_PORT,
+  plugin_manifest_exports,
+  RemotePluginLoadError,
+  isLocalUrl,
+  getRemoteEntries,
+  setInstalledVersion,
+  getInstalledVersion,
+  preload,
+  make,
+  uninstall,
+  url_loader_exports
+};
+//# sourceMappingURL=chunk-M3HKPRPO.mjs.map