Member Junction
    Preparing search index...

    Result of loading and validating a manifest.

    interface ManifestLoadResult {
        Errors?: string[];
        Manifest?: {
            $schema?: string;
            categories?: string[];
            code?: { sourceDirectory?: string; visibility?: "public" | "private" };
            color?: string;
            configuration?: { schema?: Record<string, unknown> };
            dependencies?:
                | {
                    [k: string]: {
                        repository: string;
                        subpath?: string;
                        version: string;
                    };
                }
                | Record<
                    string,
                    string
                    | { repository?: string; subpath?: string; version?: string },
                >;
            description?: string;
            displayName?: string;
            hooks?: {
                postInstall?: string;
                postInstallModule?: string;
                postUpgrade?: string;
                postUpgradeModule?: string;
                preRemove?: string;
                preRemoveModule?: string;
            };
            icon?: string;
            license?: string;
            manifestVersion?: 1;
            metadata?: { directory?: string };
            migrations?: {
                directory?: string;
                engine?: "flyway" | "skyway";
                teardownDirectory?: string;
            };
            mjVersionRange?: string;
            name?: string;
            packages?: {
                client?: {
                    name?: string;
                    role?: | "bootstrap"
                    | "actions"
                    | "engine"
                    | "provider"
                    | "module"
                    | "components"
                    | "library";
                    startupExport?: string;
                }[];
                prefix?: string;
                registry?: string;
                server?: {
                    name?: string;
                    role?: | "bootstrap"
                    | "actions"
                    | "engine"
                    | "provider"
                    | "module"
                    | "components"
                    | "library";
                    startupExport?: string;
                }[];
                shared?: {
                    name?: string;
                    role?: | "bootstrap"
                    | "actions"
                    | "engine"
                    | "provider"
                    | "module"
                    | "components"
                    | "library";
                    startupExport?: string;
                }[];
            };
            publisher?: { email?: string; name?: string; url?: string };
            repository?: string;
            schema?: {
                createIfNotExists?: boolean;
                entityPackage?: string;
                name?: string;
            };
            tags?: string[];
            version?: string;
        };
        Success: boolean;
    }
    Index

    Properties

    Errors?: string[]

    Validation errors (if failed)

    Manifest?: {
        $schema?: string;
        categories?: string[];
        code?: { sourceDirectory?: string; visibility?: "public" | "private" };
        color?: string;
        configuration?: { schema?: Record<string, unknown> };
        dependencies?:
            | {
                [k: string]: { repository: string; subpath?: string; version: string };
            }
            | Record<
                string,
                string
                | { repository?: string; subpath?: string; version?: string },
            >;
        description?: string;
        displayName?: string;
        hooks?: {
            postInstall?: string;
            postInstallModule?: string;
            postUpgrade?: string;
            postUpgradeModule?: string;
            preRemove?: string;
            preRemoveModule?: string;
        };
        icon?: string;
        license?: string;
        manifestVersion?: 1;
        metadata?: { directory?: string };
        migrations?: {
            directory?: string;
            engine?: "flyway" | "skyway";
            teardownDirectory?: string;
        };
        mjVersionRange?: string;
        name?: string;
        packages?: {
            client?: {
                name?: string;
                role?: | "bootstrap"
                | "actions"
                | "engine"
                | "provider"
                | "module"
                | "components"
                | "library";
                startupExport?: string;
            }[];
            prefix?: string;
            registry?: string;
            server?: {
                name?: string;
                role?: | "bootstrap"
                | "actions"
                | "engine"
                | "provider"
                | "module"
                | "components"
                | "library";
                startupExport?: string;
            }[];
            shared?: {
                name?: string;
                role?: | "bootstrap"
                | "actions"
                | "engine"
                | "provider"
                | "module"
                | "components"
                | "library";
                startupExport?: string;
            }[];
        };
        publisher?: { email?: string; name?: string; url?: string };
        repository?: string;
        schema?: {
            createIfNotExists?: boolean;
            entityPackage?: string;
            name?: string;
        };
        tags?: string[];
        version?: string;
    }

    The validated manifest (if successful)

    Success: boolean

    Whether parsing and validation succeeded