medusa-dynamic-metadata 0.0.1

package/.medusa/server/src/shared/metadata/utils.js

@@ -0,0 +1,153 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeMetadataDescriptors = normalizeMetadataDescriptors;
+exports.getDescriptorMap = getDescriptorMap;
+exports.buildInitialFormState = buildInitialFormState;
+exports.buildMetadataPayload = buildMetadataPayload;
+exports.hasMetadataChanges = hasMetadataChanges;
+exports.validateValueForDescriptor = validateValueForDescriptor;
+const types_1 = require("./types");
+const VALID_FIELD_TYPES = new Set(types_1.METADATA_FIELD_TYPES);
+const BOOLEAN_TRUES = new Set(["true", "1", "yes", "y", "on"]);
+const BOOLEAN_FALSES = new Set(["false", "0", "no", "n", "off"]);
+function normalizeMetadataDescriptors(input) {
+    if (!Array.isArray(input))
+        return [];
+    const seenKeys = new Set();
+    return input
+        .filter((item) => item && typeof item === "object")
+        .map(item => {
+        const key = normalizeKey(item.key);
+        const type = normalizeType(item.type);
+        const label = normalizeLabel(item.label);
+        const filterable = !!(item.filterable);
+        return { key, type, label, filterable };
+    })
+        .filter(({ key, type }) => key && type && !seenKeys.has(key))
+        .map(({ key, type, label, filterable }) => {
+        seenKeys.add(key);
+        return {
+            key: key,
+            type: type,
+            ...(label && { label }),
+            ...(filterable && { filterable: true })
+        };
+    });
+}
+function getDescriptorMap(descriptors) {
+    return descriptors.reduce((acc, descriptor) => {
+        acc[descriptor.key] = descriptor;
+        return acc;
+    }, {});
+}
+function buildInitialFormState(descriptors, metadata) {
+    const base = metadata && typeof metadata === "object" ? metadata : {};
+    return descriptors.reduce((acc, descriptor) => {
+        acc[descriptor.key] = normalizeFormValue(descriptor, base[descriptor.key]);
+        return acc;
+    }, {});
+}
+function buildMetadataPayload({ descriptors, values, originalMetadata, }) {
+    const base = originalMetadata && typeof originalMetadata === "object"
+        ? { ...originalMetadata }
+        : {};
+    descriptors.forEach((descriptor) => {
+        const coerced = coerceMetadataValue(descriptor, values[descriptor.key]);
+        if (coerced === undefined) {
+            delete base[descriptor.key];
+        }
+        else {
+            base[descriptor.key] = coerced;
+        }
+    });
+    return base;
+}
+function hasMetadataChanges({ descriptors, values, originalMetadata, }) {
+    const next = buildMetadataPayload({ descriptors, values, originalMetadata });
+    const prev = originalMetadata && typeof originalMetadata === "object"
+        ? originalMetadata
+        : {};
+    return descriptors.some(({ key }) => !isDeepEqual(prev[key], next[key]));
+}
+function validateValueForDescriptor(descriptor, value) {
+    if (descriptor.type === "number") {
+        if (value == null || value === "")
+            return undefined;
+        const num = typeof value === "number" ? value : Number(String(value).trim());
+        return isNaN(num) ? "Enter a valid number" : undefined;
+    }
+    if (descriptor.type === "file") {
+        if (!value)
+            return undefined;
+        try {
+            new URL(String(value).trim());
+            return undefined;
+        }
+        catch {
+            return "Enter a valid URL";
+        }
+    }
+    return undefined;
+}
+function normalizeFormValue(descriptor, currentValue) {
+    if (descriptor.type === "bool")
+        return Boolean(currentValue);
+    if ((descriptor.type === "number" || descriptor.type === "text") && typeof currentValue === "number") {
+        return currentValue.toString();
+    }
+    if (typeof currentValue === "string" || typeof currentValue === "number") {
+        return String(currentValue);
+    }
+    return "";
+}
+function coerceMetadataValue(descriptor, value) {
+    if (value == null || value === "")
+        return undefined;
+    if (descriptor.type === "bool") {
+        if (typeof value === "boolean")
+            return value;
+        if (typeof value === "number")
+            return value !== 0;
+        const normalized = String(value).trim().toLowerCase();
+        if (!normalized)
+            return undefined;
+        if (BOOLEAN_TRUES.has(normalized))
+            return true;
+        if (BOOLEAN_FALSES.has(normalized))
+            return false;
+        return Boolean(value);
+    }
+    if (descriptor.type === "number") {
+        const num = typeof value === "number" ? value : Number(String(value).trim());
+        return isNaN(num) ? undefined : num;
+    }
+    // For text and file types, trim and check if empty
+    const trimmed = String(value).trim();
+    if (!trimmed)
+        return undefined;
+    return trimmed;
+}
+function normalizeKey(value) {
+    return typeof value === "string" ? value.trim() || undefined : undefined;
+}
+function normalizeType(value) {
+    if (typeof value !== "string")
+        return undefined;
+    const type = value.trim().toLowerCase();
+    return VALID_FIELD_TYPES.has(type) ? type : undefined;
+}
+function normalizeLabel(value) {
+    return typeof value === "string" ? value.trim() || undefined : undefined;
+}
+function isDeepEqual(a, b) {
+    if (a === b)
+        return true;
+    if (!a || !b || typeof a !== "object" || typeof b !== "object")
+        return false;
+    const aKeys = Object.keys(a);
+    const bKeys = Object.keys(b);
+    if (aKeys.length !== bKeys.length)
+        return false;
+    return aKeys.every(key => isDeepEqual(a[key], b[key]));
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvc2hhcmVkL21ldGFkYXRhL3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBY0Esb0VBeUJDO0FBRUQsNENBS0M7QUFFRCxzREFVQztBQUVELG9EQXdCQztBQUVELGdEQWVDO0FBRUQsZ0VBdUJDO0FBOUhELG1DQUtnQjtBQUtoQixNQUFNLGlCQUFpQixHQUFHLElBQUksR0FBRyxDQUFvQiw0QkFBb0IsQ0FBQyxDQUFBO0FBQzFFLE1BQU0sYUFBYSxHQUFHLElBQUksR0FBRyxDQUFDLENBQUMsTUFBTSxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsR0FBRyxFQUFFLElBQUksQ0FBQyxDQUFDLENBQUE7QUFDOUQsTUFBTSxjQUFjLEdBQUcsSUFBSSxHQUFHLENBQUMsQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLElBQUksRUFBRSxHQUFHLEVBQUUsS0FBSyxDQUFDLENBQUMsQ0FBQTtBQUVoRSxTQUFnQiw0QkFBNEIsQ0FBQyxLQUFjO0lBQ3pELElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQztRQUFFLE9BQU8sRUFBRSxDQUFBO0lBRXBDLE1BQU0sUUFBUSxHQUFHLElBQUksR0FBRyxFQUFVLENBQUE7SUFDbEMsT0FBTyxLQUFLO1NBQ1QsTUFBTSxDQUFDLENBQUMsSUFBSSxFQUFtQyxFQUFFLENBQ2hELElBQUksSUFBSSxPQUFPLElBQUksS0FBSyxRQUFRLENBQ2pDO1NBQ0EsR0FBRyxDQUFDLElBQUksQ0FBQyxFQUFFO1FBQ1YsTUFBTSxHQUFHLEdBQUcsWUFBWSxDQUFFLElBQVksQ0FBQyxHQUFHLENBQUMsQ0FBQTtRQUMzQyxNQUFNLElBQUksR0FBRyxhQUFhLENBQUUsSUFBWSxDQUFDLElBQUksQ0FBQyxDQUFBO1FBQzlDLE1BQU0sS0FBSyxHQUFHLGNBQWMsQ0FBRSxJQUFZLENBQUMsS0FBSyxDQUFDLENBQUE7UUFDakQsTUFBTSxVQUFVLEdBQUcsQ0FBQyxDQUFDLENBQUUsSUFBWSxDQUFDLFVBQVUsQ0FBQyxDQUFBO1FBQy9DLE9BQU8sRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLEtBQUssRUFBRSxVQUFVLEVBQUUsQ0FBQTtJQUN6QyxDQUFDLENBQUM7U0FDRCxNQUFNLENBQUMsQ0FBQyxFQUFFLEdBQUcsRUFBRSxJQUFJLEVBQUUsRUFBRSxFQUFFLENBQUMsR0FBRyxJQUFJLElBQUksSUFBSSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUM7U0FDNUQsR0FBRyxDQUFDLENBQUMsRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLEtBQUssRUFBRSxVQUFVLEVBQUUsRUFBRSxFQUFFO1FBQ3hDLFFBQVEsQ0FBQyxHQUFHLENBQUMsR0FBSSxDQUFDLENBQUE7UUFDbEIsT0FBTztZQUNMLEdBQUcsRUFBRSxHQUFJO1lBQ1QsSUFBSSxFQUFFLElBQUs7WUFDWCxHQUFHLENBQUMsS0FBSyxJQUFJLEVBQUUsS0FBSyxFQUFFLENBQUM7WUFDdkIsR0FBRyxDQUFDLFVBQVUsSUFBSSxFQUFFLFVBQVUsRUFBRSxJQUFJLEVBQUUsQ0FBQztTQUN4QyxDQUFBO0lBQ0gsQ0FBQyxDQUFDLENBQUE7QUFDTixDQUFDO0FBRUQsU0FBZ0IsZ0JBQWdCLENBQUMsV0FBaUM7SUFDaEUsT0FBTyxXQUFXLENBQUMsTUFBTSxDQUF3QixDQUFDLEdBQUcsRUFBRSxVQUFVLEVBQUUsRUFBRTtRQUNuRSxHQUFHLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxHQUFHLFVBQVUsQ0FBQTtRQUNoQyxPQUFPLEdBQUcsQ0FBQTtJQUNaLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQTtBQUNSLENBQUM7QUFFRCxTQUFnQixxQkFBcUIsQ0FDbkMsV0FBaUMsRUFDakMsUUFBd0I7SUFFeEIsTUFBTSxJQUFJLEdBQUcsUUFBUSxJQUFJLE9BQU8sUUFBUSxLQUFLLFFBQVEsQ0FBQyxDQUFDLENBQUMsUUFBbUMsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFBO0lBRWhHLE9BQU8sV0FBVyxDQUFDLE1BQU0sQ0FBb0MsQ0FBQyxHQUFHLEVBQUUsVUFBVSxFQUFFLEVBQUU7UUFDL0UsR0FBRyxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxrQkFBa0IsQ0FBQyxVQUFVLEVBQUUsSUFBSSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFBO1FBQzFFLE9BQU8sR0FBRyxDQUFBO0lBQ1osQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFBO0FBQ1IsQ0FBQztBQUVELFNBQWdCLG9CQUFvQixDQUFDLEVBQ25DLFdBQVcsRUFDWCxNQUFNLEVBQ04sZ0JBQWdCLEdBS2pCO0lBQ0MsTUFBTSxJQUFJLEdBQUcsZ0JBQWdCLElBQUksT0FBTyxnQkFBZ0IsS0FBSyxRQUFRO1FBQ25FLENBQUMsQ0FBQyxFQUFFLEdBQUksZ0JBQTRDLEVBQUU7UUFDdEQsQ0FBQyxDQUFDLEVBQUUsQ0FBQTtJQUVOLFdBQVcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxVQUFVLEVBQUUsRUFBRTtRQUNqQyxNQUFNLE9BQU8sR0FBRyxtQkFBbUIsQ0FBQyxVQUFVLEVBQUUsTUFBTSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFBO1FBRXZFLElBQUksT0FBTyxLQUFLLFNBQVMsRUFBRSxDQUFDO1lBQzFCLE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQTtRQUM3QixDQUFDO2FBQU0sQ0FBQztZQUNOLElBQUksQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLEdBQUcsT0FBTyxDQUFBO1FBQ2hDLENBQUM7SUFDSCxDQUFDLENBQUMsQ0FBQTtJQUVGLE9BQU8sSUFBSSxDQUFBO0FBQ2IsQ0FBQztBQUVELFNBQWdCLGtCQUFrQixDQUFDLEVBQ2pDLFdBQVcsRUFDWCxNQUFNLEVBQ04sZ0JBQWdCLEdBS2pCO0lBQ0MsTUFBTSxJQUFJLEdBQUcsb0JBQW9CLENBQUMsRUFBRSxXQUFXLEVBQUUsTUFBTSxFQUFFLGdCQUFnQixFQUFFLENBQUMsQ0FBQTtJQUM1RSxNQUFNLElBQUksR0FBRyxnQkFBZ0IsSUFBSSxPQUFPLGdCQUFnQixLQUFLLFFBQVE7UUFDbkUsQ0FBQyxDQUFFLGdCQUE0QztRQUMvQyxDQUFDLENBQUMsRUFBRSxDQUFBO0lBRU4sT0FBTyxXQUFXLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxHQUFHLEVBQUUsRUFBRSxFQUFFLENBQUMsQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUE7QUFDMUUsQ0FBQztBQUVELFNBQWdCLDBCQUEwQixDQUN4QyxVQUE4QixFQUM5QixLQUF3QjtJQUV4QixJQUFJLFVBQVUsQ0FBQyxJQUFJLEtBQUssUUFBUSxFQUFFLENBQUM7UUFDakMsSUFBSSxLQUFLLElBQUksSUFBSSxJQUFJLEtBQUssS0FBSyxFQUFFO1lBQUUsT0FBTyxTQUFTLENBQUE7UUFFbkQsTUFBTSxHQUFHLEdBQUcsT0FBTyxLQUFLLEtBQUssUUFBUSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQTtRQUM1RSxPQUFPLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsc0JBQXNCLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQTtJQUN4RCxDQUFDO0lBRUQsSUFBSSxVQUFVLENBQUMsSUFBSSxLQUFLLE1BQU0sRUFBRSxDQUFDO1FBQy9CLElBQUksQ0FBQyxLQUFLO1lBQUUsT0FBTyxTQUFTLENBQUE7UUFFNUIsSUFBSSxDQUFDO1lBQ0gsSUFBSSxHQUFHLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLElBQUksRUFBRSxDQUFDLENBQUE7WUFDN0IsT0FBTyxTQUFTLENBQUE7UUFDbEIsQ0FBQztRQUFDLE1BQU0sQ0FBQztZQUNQLE9BQU8sbUJBQW1CLENBQUE7UUFDNUIsQ0FBQztJQUNILENBQUM7SUFFRCxPQUFPLFNBQVMsQ0FBQTtBQUNsQixDQUFDO0FBRUQsU0FBUyxrQkFBa0IsQ0FBQyxVQUE4QixFQUFFLFlBQXFCO0lBQy9FLElBQUksVUFBVSxDQUFDLElBQUksS0FBSyxNQUFNO1FBQUUsT0FBTyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUE7SUFFNUQsSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLEtBQUssUUFBUSxJQUFJLFVBQVUsQ0FBQyxJQUFJLEtBQUssTUFBTSxDQUFDLElBQUksT0FBTyxZQUFZLEtBQUssUUFBUSxFQUFFLENBQUM7UUFDckcsT0FBTyxZQUFZLENBQUMsUUFBUSxFQUFFLENBQUE7SUFDaEMsQ0FBQztJQUVELElBQUksT0FBTyxZQUFZLEtBQUssUUFBUSxJQUFJLE9BQU8sWUFBWSxLQUFLLFFBQVEsRUFBRSxDQUFDO1FBQ3pFLE9BQU8sTUFBTSxDQUFDLFlBQVksQ0FBQyxDQUFBO0lBQzdCLENBQUM7SUFFRCxPQUFPLEVBQUUsQ0FBQTtBQUNYLENBQUM7QUFFRCxTQUFTLG1CQUFtQixDQUMxQixVQUE4QixFQUM5QixLQUF3QjtJQUV4QixJQUFJLEtBQUssSUFBSSxJQUFJLElBQUksS0FBSyxLQUFLLEVBQUU7UUFBRSxPQUFPLFNBQVMsQ0FBQTtJQUVuRCxJQUFJLFVBQVUsQ0FBQyxJQUFJLEtBQUssTUFBTSxFQUFFLENBQUM7UUFDL0IsSUFBSSxPQUFPLEtBQUssS0FBSyxTQUFTO1lBQUUsT0FBTyxLQUFLLENBQUE7UUFDNUMsSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRO1lBQUUsT0FBTyxLQUFLLEtBQUssQ0FBQyxDQUFBO1FBRWpELE1BQU0sVUFBVSxHQUFHLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxXQUFXLEVBQUUsQ0FBQTtRQUNyRCxJQUFJLENBQUMsVUFBVTtZQUFFLE9BQU8sU0FBUyxDQUFBO1FBQ2pDLElBQUksYUFBYSxDQUFDLEdBQUcsQ0FBQyxVQUFVLENBQUM7WUFBRSxPQUFPLElBQUksQ0FBQTtRQUM5QyxJQUFJLGNBQWMsQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDO1lBQUUsT0FBTyxLQUFLLENBQUE7UUFDaEQsT0FBTyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUE7SUFDdkIsQ0FBQztJQUVELElBQUksVUFBVSxDQUFDLElBQUksS0FBSyxRQUFRLEVBQUUsQ0FBQztRQUNqQyxNQUFNLEdBQUcsR0FBRyxPQUFPLEtBQUssS0FBSyxRQUFRLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFBO1FBQzVFLE9BQU8sS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQTtJQUNyQyxDQUFDO0lBRUQsbURBQW1EO0lBQ25ELE1BQU0sT0FBTyxHQUFHLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQTtJQUNwQyxJQUFJLENBQUMsT0FBTztRQUFFLE9BQU8sU0FBUyxDQUFBO0lBQzlCLE9BQU8sT0FBTyxDQUFBO0FBQ2hCLENBQUM7QUFFRCxTQUFTLFlBQVksQ0FBQyxLQUFjO0lBQ2xDLE9BQU8sT0FBTyxLQUFLLEtBQUssUUFBUSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFLElBQUksU0FBUyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUE7QUFDMUUsQ0FBQztBQUVELFNBQVMsYUFBYSxDQUFDLEtBQWM7SUFDbkMsSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRO1FBQUUsT0FBTyxTQUFTLENBQUE7SUFFL0MsTUFBTSxJQUFJLEdBQUcsS0FBSyxDQUFDLElBQUksRUFBRSxDQUFDLFdBQVcsRUFBdUIsQ0FBQTtJQUM1RCxPQUFPLGlCQUFpQixDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUE7QUFDdkQsQ0FBQztBQUVELFNBQVMsY0FBYyxDQUFDLEtBQWM7SUFDcEMsT0FBTyxPQUFPLEtBQUssS0FBSyxRQUFRLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxJQUFJLEVBQUUsSUFBSSxTQUFTLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQTtBQUMxRSxDQUFDO0FBRUQsU0FBUyxXQUFXLENBQUMsQ0FBVSxFQUFFLENBQVU7SUFDekMsSUFBSSxDQUFDLEtBQUssQ0FBQztRQUFFLE9BQU8sSUFBSSxDQUFBO0lBQ3hCLElBQUksQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksT0FBTyxDQUFDLEtBQUssUUFBUSxJQUFJLE9BQU8sQ0FBQyxLQUFLLFFBQVE7UUFBRSxPQUFPLEtBQUssQ0FBQTtJQUU1RSxNQUFNLEtBQUssR0FBRyxNQUFNLENBQUMsSUFBSSxDQUFDLENBQVcsQ0FBQyxDQUFBO0lBQ3RDLE1BQU0sS0FBSyxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBVyxDQUFDLENBQUE7SUFDdEMsSUFBSSxLQUFLLENBQUMsTUFBTSxLQUFLLEtBQUssQ0FBQyxNQUFNO1FBQUUsT0FBTyxLQUFLLENBQUE7SUFFL0MsT0FBTyxLQUFLLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQ3ZCLFdBQVcsQ0FBRSxDQUE2QixDQUFDLEdBQUcsQ0FBQyxFQUFHLENBQTZCLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FDdEYsQ0FBQTtBQUNILENBQUMifQ==

package/README.md

@@ -0,0 +1,292 @@
+<p align="center">
+  <a href="https://www.medusajs.com">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/59018053/229103275-b5e482bb-4601-46e6-8142-244f531cebdb.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/59018053/229103726-e5b529a3-9b3f-4970-8a1f-c6af37f087bf.svg">
+    <img alt="Medusa logo" src="https://user-images.githubusercontent.com/59018053/229103726-e5b529a3-9b3f-4970-8a1f-c6af37f087bf.svg">
+    </picture>
+  </a>
+</p>
+<h1 align="center">
+  Medusa Dynamic Metadata
+</h1>
+
+<h4 align="center">
+  <a href="https://docs.medusajs.com">Documentation</a> |
+  <a href="https://www.medusajs.com">Website</a>
+</h4>
+
+<p align="center">
+  Building blocks for digital commerce
+</p>
+<p align="center">
+  <a href="https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md">
+    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="PRs welcome!" />
+  </a>
+    <a href="https://www.producthunt.com/posts/medusa"><img src="https://img.shields.io/badge/Product%20Hunt-%231%20Product%20of%20the%20Day-%23DA552E" alt="Product Hunt"></a>
+  <a href="https://discord.gg/xpCwq3Kfn8">
+    <img src="https://img.shields.io/badge/chat-on%20discord-7289DA.svg" alt="Discord Chat" />
+  </a>
+  <a href="https://twitter.com/intent/follow?screen_name=medusajs">
+    <img src="https://img.shields.io/twitter/follow/medusajs.svg?label=Follow%20@medusajs" alt="Follow @medusajs" />
+  </a>
+</p>
+
+## Compatibility
+
+This plugin is compatible with versions >= 2.4.0 of `@medusajs/medusa`.
+
+## Overview
+
+`medusa-dynamic-metadata` is a flexible, configuration-driven plugin that enables metadata management for any Medusa entity type. Simply configure entities in your `medusa-config.ts` file, and the plugin provides a universal widget component that automatically detects entity types and renders the appropriate metadata fields.
+
+### Key Features
+
+- **Configuration-Driven**: Enable metadata for any entity type through simple configuration
+- **Universal Widget**: Single widget component works for all entities with runtime entity detection
+- **Type-Safe**: Full TypeScript support with proper type definitions
+- **Flexible Schema**: Define metadata fields with types (text, number, bool, file) and filterability
+- **Zero Code Changes**: Add metadata to new entities by updating configuration only
+
+## Supported Entities
+
+This plugin supports metadata configuration for the following entities that have valid admin detail pages:
+
+1. **products** - Widget zone: `product.details.after`
+2. **orders** - Widget zone: `order.details.after`
+3. **categories** - Widget zone: `product_category.details.after`
+4. **collections** - Widget zone: `product_collection.details.after`
+5. **customers** - Widget zone: `customer.details.after`
+6. **regions** - Widget zone: `region.details.after`
+7. **sales_channels** - Widget zone: `sales_channel.details.after`
+8. **stores** - Widget zone: `store.details.after`
+9. **promotions** - Widget zone: `promotion.details.after`
+10. **campaigns** - Widget zone: `campaign.details.after`
+11. **price_lists** - Widget zone: `price_list.details.after`
+12. **shipping_profiles** - Widget zone: `shipping_profile.details.after`
+13. **inventory_items** - Widget zone: `inventory_item.details.after`
+14. **product_variants** - Widget zone: `product_variant.details.after`
+
+> **Note**: Only entities with valid admin detail pages can be configured. The plugin includes pre-built widget files for all 14 supported entities above.
+
+## Getting Started
+
+### Installation
+
+```bash
+npm install medusa-dynamic-metadata
+```
+
+### Configuration
+
+Add the plugin to your `medusa-config.ts`:
+
+```typescript
+import { defineConfig } from "@medusajs/framework"
+
+export default defineConfig({
+  // ... other config
+  plugins: [
+    {
+      resolve: "medusa-dynamic-metadata",
+      options: {
+        entities: {
+          products: {
+            descriptors: [
+              { key: "brand", label: "Brand", type: "text", filterable: true },
+              { key: "warranty_years", label: "Warranty (Years)", type: "number" },
+            ],
+            expose_client_helpers: true,
+            filterable: true,
+          },
+          orders: {
+            descriptors: [
+              { key: "source", label: "Source", type: "text" },
+            ],
+          },
+        },
+      },
+    },
+  ],
+})
+```
+
+### Widget Files
+
+The plugin includes minimal wrapper widget files for all 14 supported entities listed above. Each wrapper:
+
+1. Specifies the widget zone (required by Medusa's widget system)
+2. Delegates to the universal `UniversalMetadataWidget` component
+3. Automatically detects the entity type at runtime
+
+**For entities not in the supported list**: Only entities with valid admin detail pages can have metadata widgets. If you need to add support for a new entity that has a detail page in Medusa's admin, create a minimal wrapper widget file using the template in `src/admin/widgets/generic-metadata-widget.template.tsx`.
+
+### Building the Plugin
+
+```bash
+npm run build
+```
+
+This builds the plugin with all extensions.
+
+### Development
+
+```bash
+npm run dev
+```
+
+This runs the plugin in watch mode for development.
+
+## How It Works
+
+### Architecture Flow
+
+```
+Configuration (medusa-config.ts)
+    ↓
+Plugin Initialization
+    ↓
+Widget Files (minimal wrappers with zones)
+    ↓
+UniversalMetadataWidget (runtime entity detection)
+    ↓
+MetadataTableWidget (UI component)
+    ↓
+API Endpoints (save/load metadata)
+```
+
+### Universal Widget Architecture
+
+The plugin uses a single universal widget component (`UniversalMetadataWidget`) that works for all entity types:
+
+1. **Runtime Entity Detection**: The widget automatically detects the entity type using:
+   - **Zone-based detection** (primary): Resolves entity type from the widget zone (e.g., `"product.details.after"` → `"products"`)
+   - **Data structure detection** (fallback): Pattern matching on data properties (e.g., `handle`, `title` → products; `display_id`, `status` → orders)
+
+2. **Configuration Loading**: Fetches metadata descriptors from `/admin/metadata-config?entity={entityType}` based on detected entity type
+
+3. **Dynamic Rendering**: Renders appropriate form fields (text, number, bool, file) based on the descriptors
+
+4. **Metadata Management**: Saves metadata through standard Medusa entity API endpoints
+
+### Widget Structure
+
+Widget files are minimal wrappers that:
+- Specify the widget zone (required by Medusa)
+- Pass the zone to `UniversalMetadataWidget`
+- Let the universal component handle all entity-specific logic
+
+Example widget file:
+```typescript
+const Widget = ({ data }) => {
+  return <UniversalMetadataWidget data={data} zone="product.details.after" />
+}
+
+export const config = defineWidgetConfig({
+  zone: "product.details.after"
+})
+```
+
+### Creating Widgets for New Entities
+
+To add metadata support for a new entity:
+
+1. **Add configuration** in `medusa-config.ts`:
+```typescript
+entities: {
+  customers: {
+    descriptors: [
+      { key: "preferred_language", type: "text" }
+    ]
+  }
+}
+```
+
+2. **Create a minimal widget file** (if zone doesn't match existing patterns):
+   - Copy `src/admin/widgets/generic-metadata-widget.template.tsx`
+   - Update the zone to match your entity's admin zone
+   - The universal widget will automatically detect the entity type
+
+## Configuration Options
+
+### Entity Configuration
+
+Each entity in the configuration supports:
+
+- `descriptors`: Array of metadata field definitions
+  - `key`: Unique identifier for the field
+  - `label`: Display label (optional, defaults to key)
+  - `type`: Field type (`"text"`, `"number"`, `"bool"`, `"file"`)
+  - `filterable`: Whether the field can be used for filtering (default: `false`)
+- `expose_client_helpers`: Expose client-side helper functions (default: `false`)
+- `filterable`: Enable filtering for this entity (default: `false`)
+- `widget_zone`: Custom widget zone override (optional)
+- `api_endpoint`: Custom API endpoint override (optional)
+
+## API
+
+The plugin provides admin API endpoints for metadata management:
+
+- `GET /admin/metadata-config?entity={entityType}` - Get metadata descriptors for an entity
+- Metadata is managed through the standard Medusa entity APIs with metadata fields
+
+## Examples
+
+### Basic Configuration
+
+```typescript
+{
+  entities: {
+    products: {
+      descriptors: [
+        { key: "brand", type: "text", filterable: true },
+        { key: "warranty_years", type: "number" },
+      ],
+    },
+  },
+}
+```
+
+### Advanced Configuration
+
+```typescript
+{
+  entities: {
+    products: {
+      descriptors: [
+        { key: "brand", label: "Brand Name", type: "text", filterable: true },
+        { key: "warranty_years", label: "Warranty Period", type: "number" },
+        { key: "has_warranty", label: "Has Warranty", type: "bool" },
+        { key: "manual_pdf", label: "Manual PDF", type: "file" },
+      ],
+      expose_client_helpers: true,
+      filterable: true,
+      widget_zone: "product.details.after", // Optional override
+    },
+  },
+}
+```
+
+## Scripts
+
+- `npm run build` - Build the plugin
+- `npm run dev` - Run in development/watch mode
+
+## What is Medusa
+
+Medusa is a set of commerce modules and tools that allow you to build rich, reliable, and performant commerce applications without reinventing core commerce logic. The modules can be customized and used to build advanced ecommerce stores, marketplaces, or any product that needs foundational commerce primitives. All modules are open-source and freely available on npm.
+
+Learn more about [Medusa’s architecture](https://docs.medusajs.com/learn/introduction/architecture) and [commerce modules](https://docs.medusajs.com/learn/fundamentals/modules/commerce-modules) in the Docs.
+
+## Community & Contributions
+
+The community and core team are available in [GitHub Discussions](https://github.com/medusajs/medusa/discussions), where you can ask for support, discuss roadmap, and share ideas.
+
+Join our [Discord server](https://discord.com/invite/medusajs) to meet other community members.
+
+## Other channels
+
+- [GitHub Issues](https://github.com/medusajs/medusa/issues)
+- [Twitter](https://twitter.com/medusajs)
+- [LinkedIn](https://www.linkedin.com/company/medusajs)
+- [Medusa Blog](https://medusajs.com/blog/)

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "medusa-dynamic-metadata",
+  "version": "0.0.1",
+  "description": "A starter for Medusa plugins.",
+  "author": "Medusa (https://medusajs.com)",
+  "license": "MIT",
+  "files": [
+    ".medusa/server"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    "./workflows": "./.medusa/server/src/workflows/index.js",
+    "./.medusa/server/src/modules/*": "./.medusa/server/src/modules/*/index.js",
+    "./modules/*": "./.medusa/server/src/modules/*/index.js",
+    "./providers/*": "./.medusa/server/src/providers/*/index.js",
+    "./*": "./.medusa/server/src/*.js",
+    "./admin": {
+      "import": "./.medusa/server/src/admin/index.mjs",
+      "require": "./.medusa/server/src/admin/index.js",
+      "default": "./.medusa/server/src/admin/index.js"
+    }
+  },
+  "keywords": [
+    "medusa",
+    "plugin",
+    "medusa-plugin-other",
+    "medusa-plugin",
+    "medusa-v2"
+  ],
+  "scripts": {
+    "build": "medusa plugin:build",
+    "dev": "medusa plugin:develop",
+    "prepublishOnly": "medusa plugin:build"
+  },
+  "devDependencies": {
+    "@medusajs/admin-sdk": "2.12.3",
+    "@medusajs/cli": "2.12.3",
+    "@medusajs/framework": "2.12.3",
+    "@medusajs/medusa": "2.12.3",
+    "@medusajs/test-utils": "2.12.3",
+    "@medusajs/ui": "4.0.25",
+    "@medusajs/icons": "2.12.3",
+    "@swc/core": "1.5.7",
+    "@types/node": "^20.0.0",
+    "@types/react": "^18.3.2",
+    "@types/react-dom": "^18.2.25",
+    "prop-types": "^15.8.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.2",
+    "vite": "^5.2.11",
+    "yalc": "^1.0.0-pre.53",
+    "zod": "^3.23.8"
+  },
+  "dependencies": {
+    "zod": "^3.23.8"
+  },
+  "peerDependencies": {
+    "@medusajs/admin-sdk": "2.12.3",
+    "@medusajs/cli": "2.12.3",
+    "@medusajs/framework": "2.12.3",
+    "@medusajs/test-utils": "2.12.3",
+    "@medusajs/medusa": "2.12.3",
+    "@medusajs/ui": "4.0.25",
+    "@medusajs/icons": "2.12.3"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}