@gdacm/dashboard-manager 0.1.1

package/dist/DashboardInfo.d.ts

@@ -0,0 +1,122 @@
+import { GrafanaItem } from "@gdacm/grafana-items";
+import { FolderInfo } from "./FolderInfo.js";
+export type GenericMetaOptions = import("@gdacm/base-types").GenericMetaOptions;
+export type DashboardMetaOptions = import("@gdacm/base-types").DashboardMetaOptions;
+export type FolderInfoDefinition = FolderInfo | String;
+/**
+ * @typedef {import("@gdacm/base-types").GenericMetaOptions} GenericMetaOptions
+ * @typedef {import("@gdacm/base-types").DashboardMetaOptions} DashboardMetaOptions
+ */
+/**
+ * @typedef {FolderInfo|String} FolderInfoDefinition
+ */
+export declare class DashboardInfo {
+    /** @type {string|undefined} */
+    _sid: string | undefined;
+    /** @type {string|undefined} */
+    _vid: string | undefined;
+    /** @type {string|undefined} */
+    _grafanaId: string | undefined;
+    /** @type {string|undefined} */
+    _title: string | undefined;
+    /** @type {string|undefined} */
+    _emoji: string | undefined;
+    /** @type {FolderInfoDefinition[]} */
+    _path: FolderInfoDefinition[];
+    /** @type {string[]} */
+    _tags: string[];
+    /**
+     * @type {GenericMetaOptions}
+     */
+    _metaOptions: GenericMetaOptions;
+    /** @type {((uid: string, metaOption: DashboardMetaOptions) => Promise<GrafanaItem>)|undefined} */
+    _dashboardGenerator: ((uid: string, metaOption: DashboardMetaOptions) => Promise<GrafanaItem>) | undefined;
+    constructor();
+    /**
+     * @returns {string|undefined}
+     */
+    get sid(): string | undefined;
+    /**
+     * @param {string} sid
+     * @returns {this}
+     */
+    setSid(sid: string): this;
+    /**
+     * @returns {string|undefined}
+     */
+    get vid(): string | undefined;
+    /**
+     * @param {string} vid
+     * @returns {this}
+     **/
+    setVid(vid: string): this;
+    /**
+     * @returns {string|undefined}
+     */
+    get grafanaId(): string | undefined;
+    /**
+     * @param {string} grafanaId
+     * @returns {this}
+     */
+    setGrafanaId(grafanaId: string): this;
+    /**
+     * @returns {string|undefined}
+     */
+    get title(): string | undefined;
+    /**
+     * @param {string} title
+     * @returns {this}
+     */
+    setTitle(title: string): this;
+    /**
+     * @returns {string|undefined}
+     */
+    get emoji(): string | undefined;
+    /**
+     * @param {string} emoji
+     * @returns {this}
+     */
+    setEmoji(emoji: string): this;
+    /**
+     * @returns {FolderInfoDefinition[]}
+     */
+    get path(): FolderInfoDefinition[];
+    /**
+     * @param {FolderInfoDefinition[]} path
+     * @returns {this}
+     */
+    setPath(path: FolderInfoDefinition[]): this;
+    /**
+     * @param {FolderInfoDefinition[]} path
+     * @returns {this}
+     */
+    injectIntoPath(path: FolderInfoDefinition[]): this;
+    /**
+     * @returns {string[]}
+     */
+    get tags(): string[];
+    /**
+     * @param {string[]} tags
+     * @returns {this}
+     */
+    setTags(tags: string[]): this;
+    /**
+     * @returns {GenericMetaOptions}
+     */
+    get metaOptions(): GenericMetaOptions;
+    /**
+     * @param {string} key
+     * @param {any} value
+     * @returns {this}
+     */
+    addMetaOption(key: string, value: any): this;
+    /**
+     * @returns {((uid: string, metaOption: DashboardMetaOptions) => Promise<GrafanaItem>)|undefined}
+     */
+    get getDashboard(): ((uid: string, metaOption: DashboardMetaOptions) => Promise<GrafanaItem>) | undefined;
+    /**
+     * @param {((uid: string, metaOption: DashboardMetaOptions) => Promise<GrafanaItem>)|undefined} dashboardGenerator
+     * @returns {this}
+     */
+    setDashboardGenerator(dashboardGenerator: ((uid: string, metaOption: DashboardMetaOptions) => Promise<GrafanaItem>) | undefined): this;
+}

package/dist/DashboardManager.d.ts

@@ -0,0 +1,51 @@
+import { DashboardProject } from './DashboardProject.js';
+import { DashboardsInfo } from './DashboardsInfo.js';
+export type GenericMetaOptions = import("@gdacm/base-types").GenericMetaOptions;
+export type DashboardMetaOptions = import("@gdacm/base-types").DashboardMetaOptions;
+export type DashboardOptions = import("@gdacm/base-types").DashboardOptions;
+export type DashboardGenerator = (uid: string, option: Object) => Promise<Object>;
+/**
+ * @typedef {import("@gdacm/base-types").GenericMetaOptions} GenericMetaOptions
+ * @typedef {import("@gdacm/base-types").DashboardMetaOptions} DashboardMetaOptions
+ * @typedef {import("@gdacm/base-types").DashboardOptions} DashboardOptions
+ */
+/**
+ * @typedef {(uid: String, option: Object) => Promise<Object>} DashboardGenerator
+ */
+export declare class DashboardManager {
+    #private;
+    /**
+     * @type {{[projectName: string]: DashboardProject}}
+     */
+    dashboards: {
+        [projectName: string]: DashboardProject;
+    };
+    constructor();
+    /**
+     * @param {string} projectName
+     * @returns {DashboardProject} The project object
+     */
+    _ensureProjectExists(projectName: string): DashboardProject;
+    /**
+     * @param {string} projectName
+        * @param {DashboardsInfo} dashboardsInfo
+     * @returns {this}
+     */
+    registerDashboards(projectName: string, dashboardsInfo: DashboardsInfo): this;
+    /**
+     * @param {string} projectName
+     * @param {string} rootVid
+     * @param {string} rootGrafanaFolder
+     * @param {string|undefined} vidPrefix
+     * @param {GenericMetaOptions} metaOptions
+     * @returns {this}
+     */
+    setupProject(projectName: string, rootVid: string, rootGrafanaFolder: string, vidPrefix: string | undefined, metaOptions: GenericMetaOptions): this;
+    /**
+     * @param {string} projectName
+     * @param {string} rootFolderPath
+     * @param {GenericMetaOptions} [metaOptions] - Optional parameters for generating dashboards
+     * @returns {Promise<this>}
+     */
+    generateDashboards(projectName: string, rootFolderPath: string, metaOptions?: GenericMetaOptions): Promise<this>;
+}

package/dist/DashboardProject.d.ts

@@ -0,0 +1,83 @@
+import { DashboardInfo } from "./DashboardInfo.js";
+import { DashboardsInfo } from "./DashboardsInfo.js";
+export type GenericMetaOptions = import("@gdacm/base-types").GenericMetaOptions;
+export type DashboardProjectProperties = {
+    rootVid: string | undefined;
+    rootGrafanaFolder: string | undefined;
+    vidPrefix: string | undefined;
+    metaOptions: GenericMetaOptions;
+};
+/**
+ * @typedef {import("@gdacm/base-types").GenericMetaOptions} GenericMetaOptions
+ */
+/**
+ * @typedef {{
+ *   rootVid: String|undefined,
+ *   rootGrafanaFolder: String|undefined,
+ *   vidPrefix: String|undefined,
+ *   metaOptions: GenericMetaOptions
+ * }} DashboardProjectProperties<T>
+ */
+export declare class DashboardProject {
+    _name: string;
+    /**
+     * @type {DashboardProjectProperties}
+     */
+    _properties: DashboardProjectProperties;
+    /**
+     * @type {{[sid: String]: DashboardInfo}}
+     */
+    _dashboards: {
+        [sid: string]: DashboardInfo;
+    };
+    /**
+    * @type {DashboardsInfo[]}
+     */
+    _dashboardsCollection: DashboardsInfo[];
+    /**
+     * @param {String} name
+     */
+    constructor(name: string);
+    /**
+     * @param {DashboardInfo} dashboardInfo
+     */
+    addDashboardInfo(dashboardInfo: DashboardInfo): void;
+    /**
+     * @param {DashboardsInfo} dashboardsInfo
+     */
+    addDashboardsInfo(dashboardsInfo: DashboardsInfo): void;
+    /**
+     * @param {String} vid
+     */
+    setRootVid(vid: string): void;
+    /**
+     * @param {String} folder
+     */
+    setRootGrafanaFolder(folder: string): void;
+    /**
+     * @param {String} prefix
+     */
+    setVidPrefix(prefix: string): void;
+    /**
+     * @param {GenericMetaOptions} metaOptions
+     */
+    setMetaOptions(metaOptions: GenericMetaOptions): void;
+    get dashboards(): {
+        [sid: string]: DashboardInfo;
+    };
+    /**
+     * @param {Record<String, String|Number|Boolean|*>} info
+     * @returns {DashboardInfo[]}
+     */
+    getDashboards(info: Record<string, string | number | boolean | any>): DashboardInfo[];
+    get properties(): {
+        rootVid: string | undefined;
+        rootGrafanaFolder: string | undefined;
+        vidPrefix: string | undefined;
+        metaOptions: GenericMetaOptions;
+    };
+    get rootVid(): string | undefined;
+    get rootGrafanaFolder(): string | undefined;
+    get vidPrefix(): string | undefined;
+    get metaOptions(): import("@gdacm/base-types").GenericMetaOptions;
+}

package/dist/DashboardsInfo.d.ts

@@ -0,0 +1,34 @@
+import { DashboardInfo } from "./DashboardInfo.js";
+import { FolderInfo } from "./index.js";
+export type DashboardsInfoItem = (DashboardInfo | DashboardsInfo | DashboardInfo[] | DashboardsInfo[] | ((info: Object) => DashboardInfo) | ((info: Object) => DashboardsInfo) | ((info: Object) => DashboardInfo[]) | ((info: Object) => DashboardsInfo[]));
+/**
+ * @typedef {(DashboardInfo|DashboardsInfo|DashboardInfo[]|DashboardsInfo[]|((info: Object) => DashboardInfo)|((info: Object) => DashboardsInfo)|((info: Object) => DashboardInfo[])|((info: Object) => DashboardsInfo[]))} DashboardsInfoItem
+ */
+export declare class DashboardsInfo {
+    /** @type {DashboardsInfoItem[]} */
+    _items: DashboardsInfoItem[];
+    /**
+     * @type {((dashboardInfo: DashboardInfo, info: Object) => DashboardInfo)[]}
+     */
+    _onDashboard: ((dashboardInfo: DashboardInfo, info: Object) => DashboardInfo)[];
+    /**
+     * @param  {DashboardsInfoItem[]} items
+     */
+    constructor(...items: DashboardsInfoItem[]);
+    /**
+     * @param {Object} info
+     * @param {((dashboardInfo: DashboardInfo, info: Object) => DashboardInfo)[]} onDashboards
+     * @returns {DashboardInfo[]}
+     */
+    getItems(info: Object, onDashboards?: ((dashboardInfo: DashboardInfo, info: Object) => DashboardInfo)[]): DashboardInfo[];
+    /**
+     * @param {((dashboardInfo: DashboardInfo, info: Object) => DashboardInfo)} callback
+     * @returns {DashboardsInfo}
+     **/
+    forEachDashboard(callback: ((dashboardInfo: DashboardInfo, info: Object) => DashboardInfo)): DashboardsInfo;
+    /**
+     * @param {FolderInfo[]} path
+     * @returns {DashboardsInfo}
+     */
+    setPath(path: FolderInfo[]): DashboardsInfo;
+}

package/dist/FolderInfo.d.ts

@@ -0,0 +1,69 @@
+export declare class FolderInfo {
+    /** @type {string|undefined} */
+    _vid: string | undefined;
+    /** @type {string|undefined} */
+    _sid: string | undefined;
+    /** @type {string|undefined} */
+    _name: string | undefined;
+    /** @type {string|undefined} */
+    _emoji: string | undefined;
+    /** @type {string|undefined} */
+    _parentVid: string | undefined;
+    /** @type {boolean} */
+    _fromServer: boolean;
+    constructor();
+    /**
+     * @returns {string|undefined}
+     */
+    get vid(): string | undefined;
+    /**
+     * @param {string} vid
+     * @returns {FolderInfo}
+     */
+    setVid(vid: string): FolderInfo;
+    /**
+     * @returns {string|undefined}
+     */
+    get sid(): string | undefined;
+    /**
+     * @param {string} sid
+     * @returns {FolderInfo}
+     */
+    setSid(sid: string): FolderInfo;
+    /**
+     * @returns {string|undefined}
+     */
+    get name(): string | undefined;
+    /**
+     * @param {string} name
+     * @returns {FolderInfo}
+     */
+    setName(name: string): FolderInfo;
+    /**
+     * @returns {string|undefined}
+     */
+    get emoji(): string | undefined;
+    /**
+     * @param {string} emoji
+     * @returns {FolderInfo}
+     */
+    setEmoji(emoji: string): FolderInfo;
+    /**
+     * @returns {string|undefined}
+     */
+    get parentVid(): string | undefined;
+    /**
+     * @param {string} parentVid
+     * @returns {FolderInfo}
+     */
+    setParentVid(parentVid: string): FolderInfo;
+    /**
+     * @returns {boolean}
+     */
+    get fromServer(): boolean;
+    /**
+     * @param {boolean} fromServer
+     * @returns {FolderInfo}
+     */
+    setFromServer(fromServer: boolean): FolderInfo;
+}

package/dist/api/GrafanaApi.d.ts

@@ -0,0 +1,47 @@
+export declare class GrafanaApi {
+    rootUrl: string | undefined;
+    token: string | undefined;
+    /**
+     * @param {Object} [options]
+     * @param {String} [options.apiUrl] - The base URL of the Grafana API
+     * @param {String} [options.apiToken] - The API token for authentication
+     */
+    constructor(options?: {
+        apiUrl?: string;
+        apiToken?: string;
+    });
+    /**
+     * @returns {{token: String, rootUrl: String}} - The parameters for the Grafana API
+     */
+    get _parameters(): {
+        token: string;
+        rootUrl: string;
+    };
+    /**
+     * @param {String} folderVid
+     * @returns {Promise<Object>} - The response from the Grafana API for the folder information as a json object
+     */
+    getFolder(folderVid: string): Promise<Object>;
+    /**
+     * @param {String} folderName
+     * @param {String} folderVid
+     * @param {String|undefined} parentVid
+     * @returns {Promise<Object>} The response from the Grafana API
+     */
+    createFolder(folderName: string, folderVid: string, parentVid: string | undefined): Promise<Object>;
+    /**
+     *
+     * @param {String} folderVid
+     * @param {String} newFolderName
+     * @param {String|undefined} parentVid
+     * @param {Number} version
+     */
+    renameFolder(folderVid: string, newFolderName: string, parentVid: string | undefined, version: number): Promise<Object>;
+    /**
+     * @param {Object} dashboardStruct
+     * @param {String} folderVid
+     * @param {String} message
+     * @returns {Promise<Object>} The response from the Grafana API
+     */
+    createDashboard(dashboardStruct: Object, folderVid: string, message: string): Promise<Object>;
+}

package/dist/api/httpClient/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @param {String} url
+ * @param {Object} [options]
+ * @returns {Promise<Object>}
+ */
+declare const getJson: (url: string, options?: Object) => Promise<Object>;
+/**
+ * @param {String} url
+ * @param {Object|null|undefined} [data]
+ * @param {Object} [options]
+ * @returns {Promise<Object>}
+ */
+declare const postJson: (url: string, data?: Object | null | undefined, options?: Object) => Promise<Object>;
+/**
+ * @param {String} url
+ * @param {Object|null|undefined} [data]
+ * @param {Object} [options]
+ * @returns {Promise<Object>}
+ */
+declare const putJson: (url: string, data?: Object | null | undefined, options?: Object) => Promise<Object>;
+export { getJson, postJson, putJson };

package/dist/dashboards.d.ts

@@ -0,0 +1,13 @@
+import { DashboardsInfo } from "./index.js";
+export type Info = import("@gdacm/base-types").Info;
+/**
+ * @typedef {import("@gdacm/base-types").Info} Info
+ */
+/**
+ * @param {string[]} localFolders
+ * @param {string} outDir
+ * @param {Info|Info[]} infosCode
+ * @param {DashboardsInfo} dashboardsInfos
+ * @returns {Promise<void>}
+ */
+export declare const createDashboards: (localFolders: string[], outDir: string, infosCode: Info | Info[], dashboardsInfos: DashboardsInfo) => Promise<void>;

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { getEnvVarsInfo, getFromOptionsOrInfo, mergeOptions, getInfo } from './info.js';
+export { DashboardManager } from './DashboardManager.js';
+export { DashboardProject } from './DashboardProject.js';
+export { DashboardInfo } from './DashboardInfo.js';
+export { DashboardsInfo } from './DashboardsInfo.js';
+export { FolderInfo } from './FolderInfo.js';
+export { readJsonFile, writeJsonFile, ensurePathExists, readYamlFile, writeYamlFile } from './utils/io.js';
+export { createDashboards } from './dashboards.js';