mirror-cockpit-project-cockpit/pkg/shell/manifests.ts

/*
 * Copyright (C) 2024 Red Hat, Inc.
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

import { JsonValue } from "cockpit";

import {
    import_json_object,
    import_string, import_number, import_boolean, import_record, import_array,
    get, get_optional,
    validate,
} from "import-json";

export interface ManifestKeyword {
    matches: string[];
    goto: string | undefined;
    weight: number | undefined;
    translate: boolean | undefined;
}

function import_ManifestKeyword(val: JsonValue): ManifestKeyword {
    const obj = import_json_object(val);
    return {
        matches: get(obj, "matches", v => import_array(v, import_string)),
        goto: get_optional(obj, "goto", import_string),
        weight: get_optional(obj, "weight", import_number),
        translate: get_optional(obj, "translate", import_boolean),
    };
}

export interface ManifestDocs {
    label: string;
    url: string;
}

function import_ManifestDocs(val: JsonValue): ManifestDocs {
    const obj = import_json_object(val);
    return {
        label: get(obj, "label", import_string),
        url: get(obj, "url", import_string),
    };
}

export interface ManifestEntry {
    path: string | undefined;
    label: string | undefined;
    order: number | undefined;
    docs: ManifestDocs[] | undefined;
    keywords: ManifestKeyword[] | undefined;
}

function import_ManifestEntry(val: JsonValue): ManifestEntry {
    const obj = import_json_object(val);
    return {
        path: get_optional(obj, "path", import_string),
        label: get_optional(obj, "label", import_string),
        order: get_optional(obj, "order", import_number),
        docs: get_optional(obj, "docs", v => import_array(v, import_ManifestDocs)),
        keywords: get_optional(obj, "keywords", v => import_array(v, import_ManifestKeyword)),
    };
}

export interface ManifestSection {
    [name: string]: ManifestEntry;
}

function import_ManifestSection(val: JsonValue): ManifestSection {
    return import_record(val, import_ManifestEntry);
}

export interface ManifestParentSection {
    component: string | undefined;
    docs: ManifestDocs[] | undefined;
}

function import_ManifestParentSection(val: JsonValue): ManifestParentSection {
    const obj = import_json_object(val);
    return {
        component: get_optional(obj, "component", import_string),
        docs: get_optional(obj, "docs", v => import_array(v, import_ManifestDocs))
    };
}

export interface Manifest {
    dashboard: ManifestSection | undefined;
    menu: ManifestSection | undefined;
    tools: ManifestSection | undefined;

    preload: string[] | undefined;
    parent: ManifestParentSection | undefined;
    ".checksum": string | undefined;
}

function import_Manifest(val: JsonValue): Manifest {
    const obj = import_json_object(val);
    return {
        dashboard: get_optional(obj, "dashboard", import_ManifestSection),
        menu: get_optional(obj, "menu", import_ManifestSection),
        tools: get_optional(obj, "tools", import_ManifestSection),
        preload: get_optional(obj, "preload", v => import_array(v, import_string)),
        parent: get_optional(obj, "parent", import_ManifestParentSection),
        ".checksum": get_optional(obj, ".checksum", import_string),
    };
}

export interface Manifests {
    [pkg: string]: Manifest;
}

export function import_Manifests(val: JsonValue): Manifests {
    const obj = import_json_object(val);
    const res: Manifests = { };
    for (const pkg in obj) {
        const m = validate("manifests." + pkg, obj[pkg], import_Manifest, null);
        if (m)
            res[pkg] = m;
    }
    return res;
}

export interface ShellManifest {
    docs: ManifestDocs[] | undefined;
    locales: { [id: string]: string } | undefined;
}

export function import_ShellManifest(val: JsonValue): ShellManifest {
    const obj = import_json_object(val);
    return {
        docs: get_optional(obj, "docs", v => import_array(v, import_ManifestDocs)),
        locales: get_optional(obj, "locales", v => import_record(v, import_string)),
    };
}