start-sdk/compat/properties.ts

import { YAML } from "../dependencies.ts";
import { exists } from "../exists.ts";
import { ResultType, Properties, ExpectedExports, Effects } from "../types.ts";


// deno-lint-ignore no-explicit-any
const asResult = (result: any) => ({ result: result as Properties })
const noPropertiesFound: ResultType<Properties> = {
    result: {
        version: 2,
        data: {
            "Not Ready": {
                type: "string",
                value: "Could not find properties. The service might still be starting",
                qr: false,
                copyable: false,
                masked: false,
                description: "Fallback Message When Properties could not be found"
            }
        }
    }
} as const
/**
 * Default will pull from a file (start9/stats.yaml) expected to be made on the main volume
 * @param effects 
 * @returns 
 */
export const properties: ExpectedExports.properties = async (
    effects: Effects,
) => {
    if (await exists(effects, { path: "start9/stats.yaml", volumeId: "main" }) === false) {
        return noPropertiesFound;
    }
    return await effects.readFile({
        path: "start9/stats.yaml",
        volumeId: "main",
    }).then(YAML.parse).then(asResult)
};