🤖 Merge PR DefinitelyTyped#72358 Add missing top-level methods to Plotly namespace by @ianroberts

Author: ianroberts

types/plotly.js/index.d.ts

@@ -406,6 +406,32 @@ export function animate(
     opts?: Partial<AnimationOpts>,
 ): Promise<void>;
 
+export interface ValidateResult {
+    code: string;
+    container: "data" | "layout";
+    trace: number | null;
+    path: string | (string | number)[];
+    astr: string;
+    msg: string;
+}
+export function validate(data: Data[], layout: Partial<Layout>): ValidateResult[];
+export function setPlotConfig(config: Partial<Config>): void;
+
+export type TemplateFigure = Root | { data: Data[]; layout: Partial<Layout> };
+export function makeTemplate(figure: TemplateFigure): Template;
+
+export interface ValidateTemplateResult {
+    code: string;
+    index?: number;
+    traceType?: string;
+    templateCount?: number;
+    dataCount?: number;
+    path?: string;
+    templateitemname?: string;
+    msg: string;
+}
+export function validateTemplate(figure: TemplateFigure, template: Template): ValidateTemplateResult[];
+
 // Layout
 export interface Layout {
     colorway: string[];

types/plotly.js/test/core-tests.ts

@@ -815,6 +815,51 @@ function rand() {
 })();
 //////////////////////////////////////////////////////////////////////
 
+//////////////////////////////////////////////////////////////////////
+// Plotly.validate
+(() => {
+    const validateResult = Plotly.validate(data, layout);
+    for (let res of validateResult) {
+        console.log(res.code, res.msg);
+    }
+})();
+//////////////////////////////////////////////////////////////////////
+
+//////////////////////////////////////////////////////////////////////
+// Plotly.setPlotConfig
+(() => {
+    Plotly.setPlotConfig({
+        locale: "en",
+        logging: 1,
+    });
+})();
+//////////////////////////////////////////////////////////////////////
+
+//////////////////////////////////////////////////////////////////////
+// Plotly.makeTemplate with div ID
+(() => {
+    Plotly.makeTemplate(graphDiv);
+})();
+//////////////////////////////////////////////////////////////////////
+
+//////////////////////////////////////////////////////////////////////
+// Plotly.makeTemplate with {data, layout}
+(() => {
+    Plotly.makeTemplate({ data: data, layout: layout });
+})();
+//////////////////////////////////////////////////////////////////////
+
+//////////////////////////////////////////////////////////////////////
+// Plotly.validateTemplate
+(() => {
+    const tmpl = Plotly.makeTemplate({ data: data, layout: layout });
+    const validateResult = Plotly.validateTemplate(graphDiv, tmpl);
+    for (const res of validateResult) {
+        console.log(res.code, res.msg);
+    }
+})();
+//////////////////////////////////////////////////////////////////////
+
 //////////////////////////////////////////////////////////////////////
 // Using events
 (async () => {