@hartl-services/medusa-base 0.2.0 → 0.4.0

package/dist/admin-components/features/plugin-features/lib/action-runs.js

@@ -0,0 +1,74 @@
+const SUMMARY_MAX_LENGTH = 200;
+const cut = (text) => text.length > SUMMARY_MAX_LENGTH
+    ? `${text.slice(0, SUMMARY_MAX_LENGTH - 1)}…`
+    : text;
+const isPrimitive = (value) => typeof value === "string" ||
+    typeof value === "number" ||
+    typeof value === "boolean";
+/**
+ * One line for a finished run's result: a string result, else its `summary`
+ * or `message`, else its primitive top-level fields (`key: value, …`).
+ * `null` when nothing readable is there.
+ */
+export const summarizeActionResult = (result) => {
+    if (result === null || result === undefined) {
+        return null;
+    }
+    if (isPrimitive(result)) {
+        return cut(String(result));
+    }
+    if (typeof result !== "object" || Array.isArray(result)) {
+        return null;
+    }
+    const record = result;
+    for (const key of ["summary", "message"]) {
+        const value = record[key];
+        if (typeof value === "string" && value.trim()) {
+            return cut(value.trim());
+        }
+    }
+    const parts = Object.entries(record)
+        .filter((entry) => isPrimitive(entry[1]))
+        .map(([key, value]) => `${key}: ${String(value)}`);
+    return parts.length > 0 ? cut(parts.join(", ")) : null;
+};
+/** Share done in percent (0–100); `null` when the total is unknown. */
+export const progressPercent = (progress) => {
+    if (!progress || progress.total === null || progress.total <= 0) {
+        return null;
+    }
+    return Math.max(0, Math.min(100, Math.round((progress.current / progress.total) * 100)));
+};
+/** "3 / 10" or "3" (unknown total); `null` without progress. */
+export const progressCount = (progress) => {
+    if (!progress) {
+        return null;
+    }
+    return progress.total === null
+        ? String(progress.current)
+        : `${progress.current} / ${progress.total}`;
+};
+/** Short German date and time. */
+export const formatRunTime = (iso) => {
+    if (!iso) {
+        return "";
+    }
+    const date = new Date(iso);
+    return Number.isNaN(date.getTime())
+        ? iso
+        : date.toLocaleString("de-AT", { dateStyle: "short", timeStyle: "short" });
+};
+/**
+ * Whether the latest run just finished while this page watched it: the same
+ * run was `running` before and is `completed`/`failed` now.
+ */
+export const runTransition = (previous, current) => {
+    if (!previous ||
+        !current ||
+        previous.id !== current.id ||
+        previous.status !== "running" ||
+        current.status === "running") {
+        return null;
+    }
+    return current.status;
+};

package/dist/admin-components/features/plugin-features/lib/plugin-features-admin-client.d.ts

@@ -0,0 +1,363 @@
+import type { UpdatePluginFeaturesPayload, UpdatePluginSettingsPayload } from "@hartl-services/medusa-food-supplements-contracts/types/plugin-features-admin";
+export declare const listPluginFeatures: () => Promise<{
+    plugins: {
+        plugin_key: string;
+        label: string;
+        description: string | null;
+        default_enabled: boolean;
+        switchable: boolean;
+        enabled: boolean;
+        version: number;
+        features: {
+            key: string;
+            label: string;
+            description: string | null;
+            parent_key: string | null;
+            default_enabled: boolean;
+            enabled: boolean;
+            effective_enabled: boolean;
+        }[];
+        settings: ({
+            type: "secret";
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        } | {
+            type: "select";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            default: string | null;
+            value: string | null;
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        } | {
+            type: "number";
+            min: number | null;
+            max: number | null;
+            default: number | null;
+            value: number | null;
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        } | {
+            type: "string" | "boolean" | "url";
+            default: string | number | boolean | null;
+            value: string | number | boolean | null;
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        })[];
+        configured: boolean;
+        missing: string[];
+        settings_version: number;
+        actions: {
+            key: string;
+            label: string;
+            description: string | null;
+            mode: "sync" | "background";
+            confirm: string | null;
+        }[];
+        admin_page: string | null;
+    }[];
+}>;
+export declare const retrievePluginFeatures: (pluginKey: string) => Promise<{
+    plugin: {
+        plugin_key: string;
+        label: string;
+        description: string | null;
+        default_enabled: boolean;
+        switchable: boolean;
+        enabled: boolean;
+        version: number;
+        features: {
+            key: string;
+            label: string;
+            description: string | null;
+            parent_key: string | null;
+            default_enabled: boolean;
+            enabled: boolean;
+            effective_enabled: boolean;
+        }[];
+        settings: ({
+            type: "secret";
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        } | {
+            type: "select";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            default: string | null;
+            value: string | null;
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        } | {
+            type: "number";
+            min: number | null;
+            max: number | null;
+            default: number | null;
+            value: number | null;
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        } | {
+            type: "string" | "boolean" | "url";
+            default: string | number | boolean | null;
+            value: string | number | boolean | null;
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        })[];
+        configured: boolean;
+        missing: string[];
+        settings_version: number;
+        actions: {
+            key: string;
+            label: string;
+            description: string | null;
+            mode: "sync" | "background";
+            confirm: string | null;
+        }[];
+        admin_page: string | null;
+    };
+}>;
+export declare const updatePluginFeatures: (payload: UpdatePluginFeaturesPayload) => Promise<{
+    plugin: {
+        plugin_key: string;
+        label: string;
+        description: string | null;
+        default_enabled: boolean;
+        switchable: boolean;
+        enabled: boolean;
+        version: number;
+        features: {
+            key: string;
+            label: string;
+            description: string | null;
+            parent_key: string | null;
+            default_enabled: boolean;
+            enabled: boolean;
+            effective_enabled: boolean;
+        }[];
+        settings: ({
+            type: "secret";
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        } | {
+            type: "select";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            default: string | null;
+            value: string | null;
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        } | {
+            type: "number";
+            min: number | null;
+            max: number | null;
+            default: number | null;
+            value: number | null;
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        } | {
+            type: "string" | "boolean" | "url";
+            default: string | number | boolean | null;
+            value: string | number | boolean | null;
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        })[];
+        configured: boolean;
+        missing: string[];
+        settings_version: number;
+        actions: {
+            key: string;
+            label: string;
+            description: string | null;
+            mode: "sync" | "background";
+            confirm: string | null;
+        }[];
+        admin_page: string | null;
+    };
+}>;
+export declare const updatePluginSettings: (pluginKey: string, payload: UpdatePluginSettingsPayload) => Promise<{
+    plugin: {
+        plugin_key: string;
+        label: string;
+        description: string | null;
+        default_enabled: boolean;
+        switchable: boolean;
+        enabled: boolean;
+        version: number;
+        features: {
+            key: string;
+            label: string;
+            description: string | null;
+            parent_key: string | null;
+            default_enabled: boolean;
+            enabled: boolean;
+            effective_enabled: boolean;
+        }[];
+        settings: ({
+            type: "secret";
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        } | {
+            type: "select";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            default: string | null;
+            value: string | null;
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        } | {
+            type: "number";
+            min: number | null;
+            max: number | null;
+            default: number | null;
+            value: number | null;
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        } | {
+            type: "string" | "boolean" | "url";
+            default: string | number | boolean | null;
+            value: string | number | boolean | null;
+            key: string;
+            label: string;
+            description: string | null;
+            required: boolean;
+            is_set: boolean;
+            source: "default" | "stored" | "config" | "none";
+            invalidates: string[];
+        })[];
+        configured: boolean;
+        missing: string[];
+        settings_version: number;
+        actions: {
+            key: string;
+            label: string;
+            description: string | null;
+            mode: "sync" | "background";
+            confirm: string | null;
+        }[];
+        admin_page: string | null;
+    };
+}>;
+export declare const runPluginAction: (pluginKey: string, actionKey: string) => Promise<{
+    action: {
+        key: string;
+        status: "completed" | "started";
+        run: {
+            id: string;
+            plugin_key: string;
+            action_key: string;
+            status: "failed" | "completed" | "running";
+            started_at: string;
+            finished_at: string | null;
+            triggered_by: string | null;
+            message: string | null;
+            progress: {
+                current: number;
+                total: number | null;
+                label: string | null;
+            } | null;
+            result: unknown;
+        };
+        result?: unknown;
+    };
+}>;
+/** Latest runs of one action, newest first. */
+export declare const listPluginActionRuns: (pluginKey: string, actionKey: string, limit?: number) => Promise<{
+    runs: {
+        id: string;
+        plugin_key: string;
+        action_key: string;
+        status: "failed" | "completed" | "running";
+        started_at: string;
+        finished_at: string | null;
+        triggered_by: string | null;
+        message: string | null;
+        progress: {
+            current: number;
+            total: number | null;
+            label: string | null;
+        } | null;
+        result: unknown;
+    }[];
+}>;

package/dist/admin-components/features/plugin-features/lib/plugin-features-admin-client.js

@@ -0,0 +1,9 @@
+import { pluginFeaturesAdminPaths } from "@hartl-services/medusa-food-supplements-contracts/paths/plugin-features";
+import { sdk } from "../../../lib/sdk";
+export const listPluginFeatures = () => sdk.client.fetch(pluginFeaturesAdminPaths.get.list, { method: "GET" });
+export const retrievePluginFeatures = (pluginKey) => sdk.client.fetch(pluginFeaturesAdminPaths.get.retrieve(pluginKey), { method: "GET" });
+export const updatePluginFeatures = (payload) => sdk.client.fetch(pluginFeaturesAdminPaths.post.update, { method: "POST", body: payload });
+export const updatePluginSettings = (pluginKey, payload) => sdk.client.fetch(pluginFeaturesAdminPaths.post.updateSettings(pluginKey), { method: "POST", body: payload });
+export const runPluginAction = (pluginKey, actionKey) => sdk.client.fetch(pluginFeaturesAdminPaths.post.runAction(pluginKey, actionKey), { method: "POST", body: {} });
+/** Latest runs of one action, newest first. */
+export const listPluginActionRuns = (pluginKey, actionKey, limit = 1) => sdk.client.fetch(pluginFeaturesAdminPaths.get.actionRuns(pluginKey, actionKey), { method: "GET", query: { limit } });

package/dist/admin-components/features/plugin-features/lib/plugin-paths.d.ts

@@ -0,0 +1,4 @@
+/** Admin path of the hub; plugin pages live below it. */
+export declare const PLUGIN_HUB_PATH = "/settings/hartl-services";
+/** The base's page for one plugin (static `plugin` segment, see README). */
+export declare const pluginDetailPath: (pluginKey: string) => string;

package/dist/admin-components/features/plugin-features/lib/plugin-paths.js

@@ -0,0 +1,4 @@
+/** Admin path of the hub; plugin pages live below it. */
+export const PLUGIN_HUB_PATH = "/settings/hartl-services";
+/** The base's page for one plugin (static `plugin` segment, see README). */
+export const pluginDetailPath = (pluginKey) => `${PLUGIN_HUB_PATH}/plugin/${encodeURIComponent(pluginKey)}`;

package/dist/admin-components/features/plugin-features/lib/settings-draft.d.ts

@@ -0,0 +1,28 @@
+import type { AdminPluginSetting, UpdatePluginSettingsPayload } from "@hartl-services/medusa-food-supplements-contracts/types/plugin-features-admin";
+/**
+ * Form state per setting: text for string/url/number inputs and the chosen
+ * option of a select (`""` = none), a boolean for
+ * switches, text for a new secret (`""` = keep) or `null` = clear the
+ * stored secret on save.
+ */
+export type SettingsDraft = Record<string, string | boolean | null>;
+type SettingValues = UpdatePluginSettingsPayload["values"];
+export declare const initialSettingsDraft: (settings: readonly AdminPluginSetting[]) => SettingsDraft;
+/**
+ * Keys of number fields whose input the browser could not parse (e.g. "1e"):
+ * the input then reports `""`, which must not be read as "cleared".
+ */
+export type UnparsableKeys = readonly string[];
+/**
+ * Keys whose draft value cannot be sent: unparsable, not a number or
+ * outside min/max. Saving is disabled while any key is listed.
+ */
+export declare const invalidDraftKeys: (settings: readonly AdminPluginSetting[], draft: SettingsDraft, unparsable?: UnparsableKeys) => string[];
+/**
+ * Only what the user changed: an emptied field clears a STORED value
+ * (`null`); emptying a value that only comes from the configuration or the
+ * default sends nothing. A secret is sent only when typed or cleared. An
+ * unparsable number is no change (the form blocks saving meanwhile).
+ */
+export declare const changedSettingValues: (settings: readonly AdminPluginSetting[], draft: SettingsDraft, unparsable?: UnparsableKeys) => SettingValues;
+export {};

package/dist/admin-components/features/plugin-features/lib/settings-draft.js

@@ -0,0 +1,86 @@
+const initialEntry = (setting) => {
+    if (setting.type === "secret") {
+        return "";
+    }
+    if (setting.type === "boolean") {
+        return setting.value === true;
+    }
+    return setting.value === null ? "" : String(setting.value);
+};
+export const initialSettingsDraft = (settings) => Object.fromEntries(settings.map((setting) => [setting.key, initialEntry(setting)]));
+const outsideBounds = (setting, value) => (setting.min !== null && value < setting.min) ||
+    (setting.max !== null && value > setting.max);
+const numberEntryValue = (entry) => {
+    const value = Number(entry.trim());
+    return Number.isFinite(value) ? value : null;
+};
+/**
+ * Keys whose draft value cannot be sent: unparsable, not a number or
+ * outside min/max. Saving is disabled while any key is listed.
+ */
+export const invalidDraftKeys = (settings, draft, unparsable = []) => settings
+    .filter((setting) => {
+    if (setting.type !== "number") {
+        return false;
+    }
+    if (unparsable.includes(setting.key)) {
+        return true;
+    }
+    const entry = draft[setting.key];
+    if (typeof entry !== "string" || entry.trim() === "") {
+        return false;
+    }
+    const value = numberEntryValue(entry);
+    return value === null || outsideBounds(setting, value);
+})
+    .map((setting) => setting.key);
+/**
+ * Only what the user changed: an emptied field clears a STORED value
+ * (`null`); emptying a value that only comes from the configuration or the
+ * default sends nothing. A secret is sent only when typed or cleared. An
+ * unparsable number is no change (the form blocks saving meanwhile).
+ */
+export const changedSettingValues = (settings, draft, unparsable = []) => {
+    const initial = initialSettingsDraft(settings);
+    const values = {};
+    for (const setting of settings) {
+        const entry = draft[setting.key];
+        if (entry === undefined || entry === initial[setting.key]) {
+            continue;
+        }
+        if (setting.type === "secret") {
+            if (entry === null) {
+                if (setting.source === "stored") {
+                    values[setting.key] = null;
+                }
+            }
+            else if (typeof entry === "string" && entry !== "") {
+                values[setting.key] = entry;
+            }
+            continue;
+        }
+        if (setting.type === "boolean") {
+            values[setting.key] = entry === true;
+            continue;
+        }
+        if (unparsable.includes(setting.key)) {
+            continue;
+        }
+        const text = typeof entry === "string" ? entry.trim() : "";
+        if (text === "") {
+            if (setting.source === "stored") {
+                values[setting.key] = null;
+            }
+        }
+        else if (setting.type === "number") {
+            const value = numberEntryValue(text);
+            if (value !== null) {
+                values[setting.key] = value;
+            }
+        }
+        else {
+            values[setting.key] = text;
+        }
+    }
+    return values;
+};

package/dist/admin-components/features/plugin-features/queries/pluginFeatureKeys.d.ts

@@ -0,0 +1,7 @@
+export declare const pluginFeatureKeys: {
+    all: readonly ["plugin-features"];
+    list: () => readonly ["plugin-features", "list"];
+    details: () => readonly ["plugin-features", "detail"];
+    detail: (pluginKey: string) => readonly ["plugin-features", "detail", string];
+    actionRuns: (pluginKey: string, actionKey: string) => readonly ["plugin-features", "action-runs", string, string];
+};

package/dist/admin-components/features/plugin-features/queries/pluginFeatureKeys.js

@@ -0,0 +1,7 @@
+export const pluginFeatureKeys = {
+    all: ["plugin-features"],
+    list: () => [...pluginFeatureKeys.all, "list"],
+    details: () => [...pluginFeatureKeys.all, "detail"],
+    detail: (pluginKey) => [...pluginFeatureKeys.details(), pluginKey],
+    actionRuns: (pluginKey, actionKey) => [...pluginFeatureKeys.all, "action-runs", pluginKey, actionKey],
+};

package/dist/admin-components/i18n/texts.d.ts

@@ -0,0 +1,90 @@
+export declare const texts: {
+    menu: {
+        label: string;
+    };
+    page: {
+        title: string;
+        description: string;
+    };
+    states: {
+        loading: string;
+        error: string;
+        empty: string;
+        retry: string;
+        notFound: string;
+    };
+    plugin: {
+        switchLabel: (label: string) => string;
+        open: string;
+        openLabel: (label: string) => string;
+    };
+    chips: {
+        enabled: string;
+        disabled: string;
+        configured: string;
+        notConfigured: (labels: string) => string;
+    };
+    detail: {
+        back: string;
+    };
+    sections: {
+        features: string;
+        settings: string;
+        actions: string;
+    };
+    hints: {
+        pluginDisabled: string;
+        parentDisabled: (parentLabel: string) => string;
+        saving: string;
+    };
+    gate: {
+        disabled: string;
+        disabledNamed: (label: string) => string;
+        openHub: string;
+    };
+    settings: {
+        missing: (labels: string) => string;
+        save: string;
+        secretPlaceholder: string;
+        secretClear: string;
+        secretClearPending: string;
+        secretClearUndo: string;
+        secretClearLabel: (label: string) => string;
+        secretClearUndoLabel: (label: string) => string;
+        invalidates: (labels: string) => string;
+        required: string;
+        invalidNumber: string;
+        outOfRange: string;
+        numberMin: (min: number) => string;
+        numberMax: (max: number) => string;
+        numberRange: (min: number, max: number) => string;
+        selectPlaceholder: string;
+        clearHint: string;
+        source: {
+            stored: string;
+            config: string;
+            default: string;
+            none: string;
+        };
+    };
+    actions: {
+        confirmTitle: (label: string) => string;
+        confirm: string;
+        cancel: string;
+        runningSince: (time: string) => string;
+        lastCompleted: (time: string) => string;
+        lastFailed: (time: string) => string;
+    };
+    toasts: {
+        saved: string;
+        saveFailed: string;
+        conflict: string;
+        actionCompleted: (label: string) => string;
+        actionStarted: (label: string) => string;
+        actionFailed: (label: string) => string;
+        actionAlreadyRunning: (label: string) => string;
+    };
+    errors: {
+        unknown: string;
+    };
+};