@dxos/app-framework - v0.16.0
    Preparing search index...

    Function toDefinition

    • The plugin definition a manifest describes, or undefined when it lists no modules: its Config2.Plugin metadata, which the manifest carries flat, and its modules.

      Parameters

      • manifest: {
            assets: readonly string[];
            author?: string;
            dependencies?: { readonly [key: string]: string };
            dependsOn?: readonly string[];
            description?: string;
            devEntry?: string;
            homePage?: string;
            icon?: { hue?: string; key: string };
            key: string;
            modules?: readonly {
                activatesOn?:
                    | { id: DXN; specifier?: string }
                    | { events: { id: DXN; specifier?: string }[]; type: "one-of" }
                    | { events: { id: DXN; specifier?: string }[]; type: "all-of" };
                adapter?: { args?: unknown; url: string };
                environments?: readonly string[];
                id: string;
                provides: readonly { arity: "single" | "multi"; identifier: string }[];
                requires: readonly { arity: "single" | "multi"; identifier: string }[];
                url: string;
            }[];
            name: string;
            screenshots?: readonly { dark?: string; light?: string }[];
            source?: string;
            spec?: string;
            tags?: readonly string[];
            version: string;
        }
        • Readonlyassets: readonly string[]

          Relative asset paths. Relaxed vs the build PluginManifestSchema (which requires >= 1) because dev-server manifests list no assets — chunks/styles flow through the dev server on demand.

        • Optional Readonlyauthor?: string
        • Optional Readonlydependencies?: { readonly [key: string]: string }

          Declared dependencies resolved to installed versions at build time (SDK-compat source).

        • Optional ReadonlydependsOn?: readonly string[]
        • Optional Readonlydescription?: string
        • Optional ReadonlydevEntry?: string

          Present only for dev-server manifests; points at the unbundled source entry.

        • Optional ReadonlyhomePage?: string
        • Optional Readonlyicon?: { hue?: string; key: string }
        • Readonlykey: string
        • Optional Readonlymodules?: readonly {
              activatesOn?:
                  | { id: DXN; specifier?: string }
                  | { events: { id: DXN; specifier?: string }[]; type: "one-of" }
                  | { events: { id: DXN; specifier?: string }[]; type: "all-of" };
              adapter?: { args?: unknown; url: string };
              environments?: readonly string[];
              id: string;
              provides: readonly { arity: "single" | "multi"; identifier: string }[];
              requires: readonly { arity: "single" | "multi"; identifier: string }[];
              url: string;
          }[]

          Every module of a Plugin.config plugin, with its body's URL relative to the manifest. A host builds the plugin from these alone; a manifest without them (a plugin built from src/plugin.tsx) is loaded through its entry module.

        • Readonlyname: string
        • Optional Readonlyscreenshots?: readonly { dark?: string; light?: string }[]
        • Optional Readonlysource?: string
        • Optional Readonlyspec?: string
        • Optional Readonlytags?: readonly string[]
        • Readonlyversion: string

          Plugin version (semver). Sourced from the publishing project's package.json.

      Returns undefined | Plugin.Manifest