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

    Variable metaConst

    meta: {
        profile: {
            author?: string;
            createdAt?: string;
            dependsOn?: readonly string[];
            description?: string;
            homePage?: string;
            icon?: { hue?: string; key: string };
            key: string;
            name: string;
            screenshots?: readonly { dark?: string; light?: string }[];
            source?: string;
            spec?: string;
            tags?: readonly string[];
        };
        release?: {
            createdAt?: string;
            dependencies?: { readonly [key: string]: string };
            manifestHash?: string;
            moduleUrl: string;
            pluginKey?: string;
            version: string;
        };
    } = ...

    Type declaration

    • Readonlyprofile: {
          author?: string;
          createdAt?: string;
          dependsOn?: readonly string[];
          description?: string;
          homePage?: string;
          icon?: { hue?: string; key: string };
          key: string;
          name: string;
          screenshots?: readonly { dark?: string; light?: string }[];
          source?: string;
          spec?: string;
          tags?: readonly string[];
      }
      • Optional Readonlyauthor?: string
      • Optional ReadonlycreatedAt?: string

        ISO-8601 timestamp from the ATProto record.

      • Optional ReadonlydependsOn?: readonly string[]

        Composer plugin ids this plugin depends on at runtime (NSIDs). Author-declared, version-independent.

      • Optional Readonlydescription?: string

        Short description of plugin functionality.

      • Optional ReadonlyhomePage?: string

        Publisher's homepage or plugin documentation URL.

      • Optional Readonlyicon?: { hue?: string; key: string }

        Icon identifier resolvable by @ch-ui/icons (e.g. ph--sparkle--regular), with an optional palette hue.

      • Readonlykey: string

        Reverse-domain NSID — the plugin's globally-unique key and the plugin.profile rkey (e.g. org.dxos.plugin.excalidraw).

      • Readonlyname: string

        Plugin display name.

      • Optional Readonlyscreenshots?: readonly { dark?: string; light?: string }[]

        Preview images — theme-keyed screenshot URLs shown on the plugin's card.

      • Optional Readonlysource?: string

        Source repository URL.

      • Optional Readonlyspec?: string

        Relative path inside the package to a bundled MDL spec (consumed by plugin-code).

      • Optional Readonlytags?: readonly string[]

        Tags to help categorize the plugin.

    • Optional Readonlyrelease?: {
          createdAt?: string;
          dependencies?: { readonly [key: string]: string };
          manifestHash?: string;
          moduleUrl: string;
          pluginKey?: string;
          version: string;
      }
      • Optional ReadonlycreatedAt?: string

        ISO-8601 timestamp from the ATProto record.

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

        Dependencies this release was built against, resolved to installed versions. The host derives SDK compatibility from the @dxos/* subset to decide whether to offer this release.

      • Optional ReadonlymanifestHash?: string

        SHA-256 content hash of the published manifest.json, prefixed with sha256-.

      • ReadonlymoduleUrl: string

        URL the host dynamic-imports to install this specific version.

      • Optional ReadonlypluginKey?: string

        Key of the parent plugin.profile record authored by the same DID (the plugin's NSID rkey).

      • Readonlyversion: string

        Semver version string, e.g. 0.8.3.