lhcb-ntuple-wizard-test 2.0.0 → 2.0.1

package/dist/providers/MetadataProvider.d.ts

@@ -0,0 +1,87 @@
+/*****************************************************************************\
+ * (c) Copyright 2021 CERN for the benefit of the LHCb Collaboration           *
+ *                                                                             *
+ * This software is distributed under the terms of the GNU General Public      *
+ * Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING".   *
+ *                                                                             *
+ * In applying this licence, CERN does not waive the privileges and immunities *
+ * granted to it by virtue of its status as an Intergovernmental Organization  *
+ * or submit itself to any jurisdiction.                                       *
+ \*****************************************************************************/
+import { ReactNode } from "react";
+import { Particle } from "../models/particle.js";
+import { DecayData } from "../models/decayData";
+import { ToolMetadata } from "../models/dtt.js";
+export type TagHint = DecayTagHint | ParticleTagHint;
+export interface DecayTagHint {
+    description: string;
+    hide: boolean;
+    warn: boolean;
+}
+export interface ParticleTagHint {
+    description: string;
+    group: string;
+    hide: boolean;
+}
+interface ApplicationInfo {
+    Analysis: string;
+    DaVinci: string;
+    Phys: string;
+}
+interface StrippingInfo {
+    full_decays: string[];
+    output: string;
+    prescale: number;
+    stream: string[];
+    url: {
+        [key: string]: string;
+    };
+}
+export interface MetadataContext {
+    dataset: string[];
+    decays: {
+        [key: string]: DecayData;
+    };
+    embedding: {
+        [key: string]: string;
+    };
+    kgdoc: {
+        [key: string]: object;
+    };
+    lokiVariables: {
+        applicationInfo: ApplicationInfo;
+        lokiVariables: object;
+    };
+    particleProperties: {
+        [key: string]: Particle;
+    };
+    stripping: {
+        [key: string]: {
+            [key: string]: StrippingInfo;
+        };
+    };
+    strippingHints: {
+        [key: string]: {
+            davinci: string;
+            description: string;
+        };
+    };
+    tupleTools: {
+        applicationInfo: ApplicationInfo;
+        tupleTools: ToolMetadata;
+    };
+    userHints: {
+        decayTags: {
+            [key: string]: DecayTagHint;
+        };
+        particleTags: {
+            [key: string]: ParticleTagHint;
+        };
+    };
+}
+interface Props {
+    children: ReactNode;
+}
+export declare function MetadataProvider({ children }: Props): import("react/jsx-runtime").JSX.Element;
+export declare const useMetadata: () => MetadataContext | null;
+export {};

package/dist/providers/MetadataProvider.js

@@ -0,0 +1,50 @@
+import { jsxs as _jsxs, jsx as _jsx } from "react/jsx-runtime";
+/*****************************************************************************\
+ * (c) Copyright 2021 CERN for the benefit of the LHCb Collaboration           *
+ *                                                                             *
+ * This software is distributed under the terms of the GNU General Public      *
+ * Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING".   *
+ *                                                                             *
+ * In applying this licence, CERN does not waive the privileges and immunities *
+ * granted to it by virtue of its status as an Intergovernmental Organization  *
+ * or submit itself to any jurisdiction.                                       *
+ \*****************************************************************************/
+import { createContext, useContext, useEffect, useState } from "react";
+import { config } from "../config.js";
+import pako from "pako";
+const MetadataContextType = createContext(null);
+export function MetadataProvider({ children }) {
+    const [error, setError] = useState(null);
+    const [metadata, setMetadata] = useState(null);
+    async function loadDict(path) {
+        const response = await fetch(`${config.metadata_baseurl}${path}.json.gz`);
+        if (!response.ok) {
+            console.error(response);
+            return null;
+        }
+        const data = await response.arrayBuffer();
+        const unzipped = pako.inflate(new Uint8Array(data));
+        const decoded = new TextDecoder("utf-8").decode(unzipped);
+        return JSON.parse(decoded);
+    }
+    useEffect(() => {
+        const metadataContextKeys = Object.keys(config.metadata_files);
+        // Load all metadata files
+        const promises = metadataContextKeys.map(async (key) => [key, await loadDict(config.metadata_files[key])]);
+        // Build the context object
+        Promise.all(promises)
+            .then((entries) => {
+            setMetadata(Object.fromEntries(entries));
+        })
+            .catch(setError);
+    }, []);
+    if (error) {
+        return _jsxs("h1", { children: ["Oops: ", `${error}`] });
+    }
+    else {
+        return _jsx(MetadataContextType.Provider, { value: metadata, children: children });
+    }
+}
+export const useMetadata = () => {
+    return useContext(MetadataContextType);
+};

package/dist/providers/ProductionConfigProvider.d.ts

@@ -0,0 +1,14 @@
+import { ReactNode } from "react";
+import { BlobFile } from "../models/blobFile";
+import { RowData } from "../models/rowData";
+import { MetadataContext } from "./MetadataProvider";
+export interface ProductionConfigApi {
+    parseProductionFiles(this: void, files: (BlobFile | File)[], metadata: MetadataContext): Promise<{
+        rows: RowData[];
+        emails: string[];
+    }>;
+}
+export declare function ProductionConfigProvider({ children }: {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function useProductionConfig(): ProductionConfigApi;

package/dist/providers/ProductionConfigProvider.js

@@ -0,0 +1,76 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, useCallback, useContext, useMemo } from "react";
+import yaml from "js-yaml";
+import Dtt from "../models/dtt";
+const ProductionConfigContext = createContext(null);
+export function ProductionConfigProvider({ children }) {
+    const parseInput = useCallback((decay) => (input) => {
+        const [, , stream, , lineName] = input.split("/");
+        const line = `Stripping${lineName}`;
+        return {
+            stream,
+            line,
+            versions: decay.lines[`${stream}/${line}`],
+        };
+    }, []);
+    const applyInfoYaml = useCallback((config, rows, emails) => {
+        const defaults = config.defaults;
+        if (defaults?.inform?.[0]) {
+            emails.push(defaults.inform[0]);
+        }
+        rows.forEach((row) => {
+            if (!row.dtt?.config.name)
+                return;
+            const dttName = row.dtt.config.name.split("/")[1];
+            Object.entries(config).forEach(([key, jobConfig]) => {
+                if (key === "defaults")
+                    return;
+                const job = jobConfig;
+                if (!job.options)
+                    return;
+                if (job.options.some((opt) => opt.split(".")[0] === dttName)) {
+                    row.paths.push(job.input.bk_query);
+                }
+            });
+        });
+    }, []);
+    const parseProductionFiles = useCallback(async (files, metadata) => {
+        const rows = [];
+        const emails = [];
+        const sorted = [...files].sort((a, b) => (a.name === "info.yaml" ? 1 : b.name === "info.yaml" ? -1 : 0));
+        for (let i = 0; i < sorted.length; i++) {
+            const file = sorted[i];
+            const blob = file.blob ?? file;
+            const text = await blob.text();
+            if (file.name === "info.yaml") {
+                const config = yaml.load(text);
+                applyInfoYaml(config, rows, emails);
+                continue;
+            }
+            const config = yaml.load(text);
+            const decay = Object.values(metadata.decays).find((d) => d.descriptors.template === config.descriptorTemplate);
+            if (!decay || !config.inputs)
+                continue;
+            rows.push({
+                id: i,
+                decay,
+                lines: config.inputs.map(parseInput(decay)),
+                paths: [],
+                pathOptions: [],
+                dtt: new Dtt(config, {}),
+            });
+        }
+        return { rows, emails };
+    }, [applyInfoYaml, parseInput]);
+    const api = useMemo(() => ({
+        parseProductionFiles,
+    }), [parseProductionFiles]);
+    return _jsx(ProductionConfigContext.Provider, { value: api, children: children });
+}
+export function useProductionConfig() {
+    const ctx = useContext(ProductionConfigContext);
+    if (!ctx) {
+        throw new Error("useProductionConfig must be used within ProductionConfigProvider");
+    }
+    return ctx;
+}

package/dist/providers/RequestProvider.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode } from "react";
+interface RequestContextType {
+    productionName: string;
+    setProductionName: (name: string) => void;
+    contactEmails: string[];
+    setContactEmails: (emails: string[]) => void;
+    reasonForRequest: string;
+    setReasonForRequest: (reason: string) => void;
+}
+interface RequestProviderProps {
+    children: ReactNode;
+}
+export declare const RequestProvider: ({ children }: RequestProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useRequest: () => RequestContextType;
+export {};

package/dist/providers/RequestProvider.js

@@ -0,0 +1,35 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, useContext, useState } from "react";
+const RequestContext = createContext(null);
+export const RequestProvider = ({ children }) => {
+    const [productionName, setProductionName] = useState(localStorage.getItem("name") || "");
+    const [contactEmails, setContactEmails] = useState((localStorage.getItem("email") || "").split(/,/).filter((s) => s));
+    const [reasonForRequest, setReasonForRequest] = useState(localStorage.getItem("reasonForRequest") || "");
+    const updateProductionName = (newProductionName) => {
+        setProductionName(newProductionName);
+        localStorage.setItem("name", newProductionName);
+    };
+    const updateContactEmails = (newContactEmails) => {
+        setContactEmails(newContactEmails);
+        localStorage.setItem("email", newContactEmails.join(","));
+    };
+    const updateReasonForRequest = (newReasonForRequest) => {
+        setReasonForRequest(newReasonForRequest);
+        localStorage.setItem("reasonForRequest", newReasonForRequest);
+    };
+    return (_jsx(RequestContext.Provider, { value: {
+            productionName,
+            setProductionName: updateProductionName,
+            contactEmails,
+            setContactEmails: updateContactEmails,
+            reasonForRequest,
+            setReasonForRequest: updateReasonForRequest,
+        }, children: children }));
+};
+export const useRequest = () => {
+    const ctx = useContext(RequestContext);
+    if (!ctx) {
+        throw new Error("useRequest must be used within a RequestProvider");
+    }
+    return ctx;
+};

package/dist/providers/RowsProvider.d.ts

@@ -0,0 +1,14 @@
+import { Dispatch, ReactNode, SetStateAction } from "react";
+import { RowData } from "../models/rowData.js";
+import { YamlFile } from "../models/yamlFile";
+interface RowsContextType {
+    rows: RowData[];
+    setRows: Dispatch<SetStateAction<RowData[]>>;
+    generateAllFiles: () => YamlFile[];
+}
+interface Props {
+    children: ReactNode;
+}
+export declare const RowsProvider: ({ children }: Props) => import("react/jsx-runtime").JSX.Element;
+export declare const useRows: () => RowsContextType;
+export {};

package/dist/providers/RowsProvider.js

@@ -0,0 +1,31 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, useContext, useEffect, useState } from "react";
+import Dtt from "../models/dtt";
+import { useMetadata } from "./MetadataProvider";
+import { YamlFile } from "../models/yamlFile";
+const RowsContext = createContext(undefined);
+export const RowsProvider = ({ children }) => {
+    const metadata = useMetadata();
+    const storedRows = JSON.parse(localStorage.getItem("rows") || "[]");
+    const [rows, setRows] = useState(storedRows.map((row) => ({ ...row, dtt: row.dtt?.config ? new Dtt(row.dtt.config, {}) : null })));
+    useEffect(() => {
+        localStorage.setItem("rows", JSON.stringify(rows));
+    }, [rows]);
+    const generateAllFiles = () => {
+        if (!metadata) {
+            return [];
+        }
+        return [
+            ...rows.filter((row) => row.dtt).map((row) => YamlFile.fromDtt(row.dtt)),
+            YamlFile.createInfoYaml(rows, metadata),
+        ];
+    };
+    return _jsx(RowsContext.Provider, { value: { rows, setRows, generateAllFiles }, children: children });
+};
+export const useRows = () => {
+    const context = useContext(RowsContext);
+    if (!context) {
+        throw new Error("useRows must be used within a RowsProvider");
+    }
+    return context;
+};

package/dist/utils/mathjaxUtils.d.ts

@@ -0,0 +1,12 @@
+/*****************************************************************************\
+ * (c) Copyright 2021 CERN for the benefit of the LHCb Collaboration           *
+ *                                                                             *
+ * This software is distributed under the terms of the GNU General Public      *
+ * Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING".   *
+ *                                                                             *
+ * In applying this licence, CERN does not waive the privileges and immunities *
+ * granted to it by virtue of its status as an Intergovernmental Organization  *
+ * or submit itself to any jurisdiction.                                       *
+ \*****************************************************************************/
+import "@mathjax/src/cjs/input/tex/ams/AmsConfiguration.js";
+export declare function tex2svg(inputTeX: string): SVGElement;

package/dist/utils/mathjaxUtils.js

@@ -0,0 +1,24 @@
+/*****************************************************************************\
+ * (c) Copyright 2021 CERN for the benefit of the LHCb Collaboration           *
+ *                                                                             *
+ * This software is distributed under the terms of the GNU General Public      *
+ * Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING".   *
+ *                                                                             *
+ * In applying this licence, CERN does not waive the privileges and immunities *
+ * granted to it by virtue of its status as an Intergovernmental Organization  *
+ * or submit itself to any jurisdiction.                                       *
+ \*****************************************************************************/
+import { mathjax } from "@mathjax/src/cjs/mathjax.js";
+import { TeX } from "@mathjax/src/cjs/input/tex.js";
+import { SVG } from "@mathjax/src/cjs/output/svg.js";
+import { browserAdaptor } from "@mathjax/src/cjs/adaptors/browserAdaptor.js";
+import { RegisterHTMLHandler } from "@mathjax/src/cjs/handlers/html.js";
+import "@mathjax/src/cjs/input/tex/ams/AmsConfiguration.js";
+RegisterHTMLHandler(browserAdaptor());
+const mathDoc = mathjax.document("", {
+    InputJax: new TeX({ packages: ["base", "ams"] }),
+    OutputJax: new SVG({ fontCache: "none" }),
+});
+export function tex2svg(inputTeX) {
+    return mathDoc.convert(inputTeX);
+}

package/dist/utils/utils.d.ts

@@ -0,0 +1,31 @@
+import { YamlFile } from "../models/yamlFile";
+/**
+ * Sanitizes a user-provided filename to prevent path traversal (Zip Slip)
+ * and unsafe filesystem characters.
+ *
+ * Guarantees the result is a single filename, not a path.
+ *
+ * - Strips directory separators (/ and \)
+ * - Removes path traversal sequences (..)
+ * - Removes leading dots
+ * - Allowlists safe characters
+ *
+ * @param input - Potentially unsafe filename
+ * @param fallback - Filename to use if sanitization results in an empty string
+ * @returns A safe filename
+ */
+export declare function sanitizeFilename(input: string, fallback?: string): string;
+/**
+ * Downloads a text string with the given filename.
+ *
+ * @param yamlFile - The YamlFile object to download
+ * @param type - The MIME type of the file (default: text/plain)
+ */
+export declare function downloadText(yamlFile: YamlFile, type?: string): void;
+/**
+ * Downloads a ZIP archive containing multiple text files.
+ *
+ * @param files - An array of [filename, content] pairs
+ * @param name - The desired archive filename
+ */
+export declare function downloadZip(files: YamlFile[], name?: string): Promise<void>;

package/dist/utils/utils.js

@@ -0,0 +1,80 @@
+/*****************************************************************************\
+ * (c) Copyright 2021 CERN for the benefit of the LHCb Collaboration           *
+ *                                                                             *
+ * This software is distributed under the terms of the GNU General Public      *
+ * Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING".   *
+ *                                                                             *
+ * In applying this licence, CERN does not waive the privileges and immunities *
+ * granted to it by virtue of its status as an Intergovernmental Organization  *
+ * or submit itself to any jurisdiction.                                       *
+ \*****************************************************************************/
+import JsZip from "jszip";
+/**
+ * Sanitizes a user-provided filename to prevent path traversal (Zip Slip)
+ * and unsafe filesystem characters.
+ *
+ * Guarantees the result is a single filename, not a path.
+ *
+ * - Strips directory separators (/ and \)
+ * - Removes path traversal sequences (..)
+ * - Removes leading dots
+ * - Allowlists safe characters
+ *
+ * @param input - Potentially unsafe filename
+ * @param fallback - Filename to use if sanitization results in an empty string
+ * @returns A safe filename
+ */
+export function sanitizeFilename(input, fallback = "file") {
+    // Get the last path segment
+    const basename = input.split(/[/\\]/).pop() ?? "";
+    const noTraversal = basename.replace(/\.\./g, "");
+    const noLeadingDots = noTraversal.replace(/^\.+/, "");
+    const sanitized = noLeadingDots.replace(/[^a-zA-Z0-9._-]/g, "");
+    return sanitized.length > 0 ? sanitized : fallback;
+}
+/**
+ * Downloads a Blob object with the given filename.
+ *
+ * @param blob - The Blob object to download
+ * @param name - The desired filename
+ */
+function downloadBlob(blob, name) {
+    const safeName = sanitizeFilename(name);
+    const blobUrl = URL.createObjectURL(blob);
+    const link = document.createElement("a");
+    link.href = blobUrl;
+    link.download = safeName;
+    document.body.appendChild(link);
+    link.dispatchEvent(new MouseEvent("click", {
+        bubbles: true,
+        cancelable: true,
+        view: window,
+    }));
+    document.body.removeChild(link);
+}
+/**
+ * Downloads a text string with the given filename.
+ *
+ * @param yamlFile - The YamlFile object to download
+ * @param type - The MIME type of the file (default: text/plain)
+ */
+export function downloadText(yamlFile, type = "text/plain") {
+    const blob = new Blob([yamlFile.content], { type: type });
+    downloadBlob(blob, yamlFile.name);
+}
+/**
+ * Downloads a ZIP archive containing multiple text files.
+ *
+ * @param files - An array of [filename, content] pairs
+ * @param name - The desired archive filename
+ */
+export async function downloadZip(files, name = "archive.zip") {
+    const zip = JsZip();
+    const safeZipName = sanitizeFilename(name, "archive.zip");
+    for (const file of files) {
+        const blob = new Blob([file.content], { type: "text/plain" });
+        zip.file(file.name, blob);
+    }
+    const blob = await zip.generateAsync({ type: "blob" });
+    downloadBlob(blob, safeZipName);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lhcb-ntuple-wizard-test",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "An application to access large-scale open data from LHCb",
   "url": "https://gitlab.cern.ch/lhcb-dpa/wp6-analysis-preservation-and-open-data/lhcb-ntuple-wizard-frontend/issues",
   "private": false,
@@ -43,7 +43,8 @@
   },
   "scripts": {
     "start": "vite --open",
-    "build": "tsc"
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
   },
   "browserslist": {
     "production": [