@hartl-services/medusa-base 2.7.0 → 2.8.0

package/dist/public/descriptor.js

@@ -15,6 +15,7 @@ const SETTING_TYPES = new Set([
     "select",
     "image",
     "color",
+    "date",
 ]);
 const HEX_COLOR_PATTERN = /^#[0-9a-f]{6}$/;
 const ACTION_MODES = new Set(["sync", "background"]);
@@ -24,7 +25,7 @@ const ADMIN_PAGE_PATTERN = /^\/settings\/hartl-services(\/[a-z0-9][a-z0-9_-]*)+$
 const ICON_NAMES = new Set(plugin_icons_1.PLUGIN_ICON_NAMES);
 const SETTING_WIDTHS = new Set(["full", "half"]);
 /** Types an input placeholder makes no sense for. */
-const NO_PLACEHOLDER_TYPES = new Set(["boolean", "select", "image", "color"]);
+const NO_PLACEHOLDER_TYPES = new Set(["boolean", "select", "image", "color", "date"]);
 const invalid = (pluginKey, message) => new utils_1.MedusaError(utils_1.MedusaError.Types.INVALID_DATA, `Ungültige Funktionsschalter für Plugin "${pluginKey}": ${message}`);
 const defaultMatchesType = (setting) => {
     const value = setting.default;
@@ -36,6 +37,8 @@ const defaultMatchesType = (setting) => {
             return typeof value === "string" && (0, lib_1.isHttpUrl)(value);
         case "color":
             return typeof value === "string" && HEX_COLOR_PATTERN.test(value);
+        case "date":
+            return typeof value === "string" && (0, lib_1.isCalendarDate)(value);
         case "number":
             return (typeof value === "number" &&
                 Number.isFinite(value) &&
@@ -222,9 +225,26 @@ const validateAdminPage = (pluginKey, path) => {
         throw invalid(pluginKey, `admin_page "${String(path)}" muss unter "${ADMIN_PAGE_PREFIX}<plugin>" liegen und darf nicht mit "${BASE_PAGE_PREFIX}" beginnen.`);
     }
 };
+/**
+ * `visible_when` points at a select or boolean setting outside the group and
+ * `equals` is one of its possible values.
+ */
+const validateVisibleWhen = (pluginKey, groupName, condition, settings) => {
+    if (condition === undefined) {
+        return;
+    }
+    const { setting: key, equals } = (condition ?? {});
+    const target = settings.find((setting) => setting.key === key);
+    const fits = target?.type === "select"
+        ? (target.options ?? []).some((option) => option.value === equals)
+        : target?.type === "boolean" && typeof equals === "boolean";
+    if (!target || target.group === groupName || !fits) {
+        throw invalid(pluginKey, `Einstellungsgruppe "${groupName}": visible_when muss auf eine Auswahl oder einen Schalter außerhalb der Gruppe mit einem ihrer Werte zeigen.`);
+    }
+};
 /**
  * Metadata per settings group: unique names, each used by a setting's
- * `group`, `requires_feature` a declared feature key.
+ * `group`, `requires_feature` a declared feature key, `visible_when` valid.
  */
 const validateSettingGroups = (pluginKey, groups, settings, featureKeys) => {
     if (groups === undefined) {
@@ -255,6 +275,7 @@ const validateSettingGroups = (pluginKey, groups, settings, featureKeys) => {
             !featureKeys.has(group.requires_feature)) {
             throw invalid(pluginKey, `Einstellungsgruppe "${group.name}": requires_feature "${String(group.requires_feature)}" ist kein Feature dieses Plugins.`);
         }
+        validateVisibleWhen(pluginKey, group.name, group.visible_when, settings);
     }
 };
 /** Optional texts and icon of the plugin's Admin page. */

package/dist/public/types.d.ts

@@ -36,8 +36,9 @@ export type PluginFeatureDefinition<K extends string = string> = {
 /**
  * `image`: public http(s) URL of an image the Admin uploads (PNG/JPEG).
  * `color`: lowercase hex color `#rrggbb`.
+ * `date`: calendar day `YYYY-MM-DD`.
  */
-export type PluginSettingType = "string" | "url" | "number" | "boolean" | "secret" | "select" | "image" | "color";
+export type PluginSettingType = "string" | "url" | "number" | "boolean" | "secret" | "select" | "image" | "color" | "date";
 /** One allowed value of a `"select"` setting. */
 export type PluginSettingOption = {
     readonly value: string;
@@ -76,7 +77,7 @@ export type PluginSettingDefinition<S extends string = string> = {
      * Short text under the field; the Admin shows `hint ?? description`.
      */
     readonly hint?: string;
-    /** Input placeholder; not for boolean, select, image and color. */
+    /** Input placeholder; not for boolean, select, image, color and date. */
     readonly placeholder?: string;
     /**
      * `"half"`: consecutive half-width settings share one two-column row.
@@ -90,7 +91,7 @@ export type PluginSettingDefinition<S extends string = string> = {
     readonly section?: string;
 };
 /** Metadata of one settings group, keyed by the `group` name of its settings. */
-export type PluginSettingGroupDefinition<K extends string = string> = {
+export type PluginSettingGroupDefinition<K extends string = string, S extends string = string> = {
     /** Equals the `group` of at least one setting; unique per plugin. */
     readonly name: string;
     /** Explanatory text under the group heading. */
@@ -102,6 +103,15 @@ export type PluginSettingGroupDefinition<K extends string = string> = {
      * (still editable) while the feature is not effectively enabled.
      */
     readonly requires_feature?: K;
+    /**
+     * The group applies only while the select or boolean setting `setting`
+     * (of another group) resolves to `equals`. Otherwise the Admin hides it and
+     * its required settings do not count as missing; stored values are kept.
+     */
+    readonly visible_when?: {
+        readonly setting: S;
+        readonly equals: string | boolean;
+    };
 };
 export type PluginActionMode = "sync" | "background";
 export type PluginActionDefinition<A extends string = string> = {
@@ -161,7 +171,7 @@ export type PluginFeatureDescriptor<K extends string = string, S extends string
      */
     readonly require_enabled_feature?: true;
     /** Metadata for the groups used in `settings[].group`. */
-    readonly setting_groups?: readonly PluginSettingGroupDefinition<K>[];
+    readonly setting_groups?: readonly PluginSettingGroupDefinition<K, S>[];
 };
 /** Values a plugin received from medusa-config; the base shows them as source "config". */
 export type PluginSettingsFallback<S extends string = string> = Partial<Record<S, PluginSettingValue | null | undefined>>;

package/dist/shared/lib/dates.d.ts

@@ -10,3 +10,5 @@ export declare const toWireDate: (value: Date | string) => string;
 export declare const toOptionalWireDate: (value: Date | string | null | undefined) => string | null;
 /** Whether the value is an IANA time zone this runtime knows ("Europe/Vienna"). */
 export declare const isValidTimeZone: (value: unknown) => value is string;
+/** Whether the value is an existing calendar day written `yyyy-mm-dd`. */
+export declare const isCalendarDate: (value: unknown) => value is string;

package/dist/shared/lib/dates.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidTimeZone = exports.toOptionalWireDate = exports.toWireDate = exports.toIsoDate = exports.startOfUtcDate = exports.toValidDate = void 0;
+exports.isCalendarDate = exports.isValidTimeZone = exports.toOptionalWireDate = exports.toWireDate = exports.toIsoDate = exports.startOfUtcDate = exports.toValidDate = void 0;
 const utils_1 = require("@medusajs/framework/utils");
 /** A valid `Date`; throws `INVALID_DATA` for an unparsable value. */
 const toValidDate = (value, message = "Invalid date.") => {
@@ -40,3 +40,9 @@ const isValidTimeZone = (value) => {
     }
 };
 exports.isValidTimeZone = isValidTimeZone;
+/** Whether the value is an existing calendar day written `yyyy-mm-dd`. */
+const isCalendarDate = (value) => typeof value === "string" &&
+    /^\d{4}-\d{2}-\d{2}$/.test(value) &&
+    !Number.isNaN(Date.parse(`${value}T00:00:00Z`)) &&
+    new Date(`${value}T00:00:00Z`).toISOString().slice(0, 10) === value;
+exports.isCalendarDate = isCalendarDate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hartl-services/medusa-base",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "Base plugin for Hartl Services Medusa shops: per-plugin feature toggles with a generic Admin settings page, a Store endpoint for storefronts, enforcement helpers, the complete-cart hook composition, the root redirect, cart-promotion link repair, the built-in E-Mail, Documents and S3 file storage modules, config helpers with the turnkey food-shop preset, and the Sentry logger wrapper and instrumentation.",
   "license": "MIT",
   "files": [
@@ -101,7 +101,7 @@
     "mime-types": "3.0.1",
     "nodemailer": "6.10.1",
     "ulid": "^2.4.0",
-    "@hartl-services/medusa-food-supplements-contracts": "^0.27.0"
+    "@hartl-services/medusa-food-supplements-contracts": "^0.28.0"
   },
   "devDependencies": {
     "@medusajs/admin-sdk": "2.19.0",