@morscherlab/mint-sdk 1.2.0-beta.4 → 1.2.0-beta.5

package/dist/composables/workspaceRecipes.d.ts

@@ -0,0 +1,188 @@
+import { TopBarVariant } from '../types';
+import { FormEnhancements } from '../types/form-builder';
+import { ControlModel, ControlModelBinding, ControlSchema, ControlWorkspaceOptions, UseControlWorkspaceReturn } from './useControlSchema';
+/**
+ * Merges `initialValues`/external `modelValue`/`values` on top of a base
+ * `ControlWorkspaceOptions.initialValues`, matching the layering FormBuilder expects: base
+ * defaults, then caller-supplied initial values, then live external values win last. Shared by
+ * {@link controlWorkspaceProps} and {@link bioTemplatePresetWorkspaceProps} so both "generate a
+ * workspace from options, initialValues, and v-model" views merge options identically.
+ */
+export declare function resolveControlOptionsWithExternalValues<TOptions extends ControlWorkspaceOptions>(base: TOptions, initialValues: Record<string, unknown> | undefined, externalValues: Record<string, unknown> | undefined): TOptions;
+export interface ControlWorkspaceModelProps {
+    model?: ControlModel | ControlModelBinding;
+    controls?: ControlSchema;
+    controlOptions?: ControlWorkspaceOptions;
+    initialValues?: Record<string, unknown>;
+    modelValue?: Record<string, unknown>;
+    values?: Record<string, unknown>;
+}
+export interface ResolvedControlWorkspaceModel {
+    /** `modelValue` if provided, else `values` — the single external v-model source of truth. */
+    externalValues: Record<string, unknown> | undefined;
+    /** `model` resolved through `resolveControlModel()`, or undefined for a raw `controls` schema. */
+    resolvedModel: ControlModelBinding | undefined;
+    /** `controls` if provided, else the resolved model's controls, else `{}`. */
+    resolvedControls: ControlSchema;
+    /** `controlOptions` merged over the resolved model's own options, with initialValues/external values layered on top. */
+    resolvedControlOptions: ControlWorkspaceOptions;
+}
+/**
+ * Resolves ControlWorkspaceView's `model`/`controls`/`controlOptions`/`initialValues`/
+ * `modelValue`/`values` props into the schema + options pair `useControlWorkspace()` needs.
+ * Pure and framework-free so callers wrap each field in their own `computed()`.
+ *
+ * @example Recommended
+ * ```ts
+ * const resolved = computed(() => controlWorkspaceProps(props))
+ * const resolvedControls = computed(() => resolved.value.resolvedControls)
+ * ```
+ */
+export declare function controlWorkspaceProps(props: ControlWorkspaceModelProps): ResolvedControlWorkspaceModel;
+export interface DoseDesignWorkspacePassthroughProps {
+    workspace?: UseControlWorkspaceReturn<ControlSchema>;
+    controlOptions?: ControlWorkspaceOptions;
+    initialValues?: Record<string, unknown>;
+    modelValue?: Record<string, unknown>;
+    values?: Record<string, unknown>;
+    title?: string;
+    subtitle?: string;
+    topBarVariant?: TopBarVariant;
+    sidebarWidth?: string;
+    sidebarVariant?: 'default' | 'analysis';
+    responsiveSidebar?: boolean;
+    sidebarPosition?: 'left' | 'right';
+    sidebarTitle?: string;
+    sidebarSubtitle?: string;
+    sidebarBadge?: string | number;
+    floating?: boolean;
+    dense?: boolean;
+    showSettings?: boolean;
+    showFormActions?: boolean;
+    formEnhancements?: FormEnhancements<Record<string, unknown>>;
+    formLoading?: boolean;
+    formDisabled?: boolean;
+    formReadonly?: boolean;
+    formSize?: 'sm' | 'md' | 'lg';
+}
+/**
+ * Maps DoseDesignWorkspaceView's props straight through to the identically-named
+ * ControlWorkspaceView props it wraps — the ~25-key pass-through list that used to be spelled
+ * out attribute-by-attribute in the template. `model` is the caller's already-resolved dose
+ * design model, not the raw (possibly absent) `props.model`.
+ *
+ * @example Recommended
+ * ```vue
+ * <ControlWorkspaceView v-bind="doseDesignWorkspaceProps(props, resolvedModel)" />
+ * ```
+ */
+export declare function doseDesignWorkspaceProps(props: DoseDesignWorkspacePassthroughProps, model: ControlModel | ControlModelBinding): {
+    model: ControlModel | ControlModelBinding;
+    workspace: UseControlWorkspaceReturn<ControlSchema> | undefined;
+    controlOptions: ControlWorkspaceOptions | undefined;
+    initialValues: Record<string, unknown> | undefined;
+    modelValue: Record<string, unknown> | undefined;
+    values: Record<string, unknown> | undefined;
+    title: string | undefined;
+    subtitle: string | undefined;
+    topBarVariant: TopBarVariant | undefined;
+    sidebarWidth: string | undefined;
+    sidebarVariant: "default" | "analysis" | undefined;
+    responsiveSidebar: boolean | undefined;
+    sidebarPosition: "left" | "right" | undefined;
+    sidebarTitle: string | undefined;
+    sidebarSubtitle: string | undefined;
+    sidebarBadge: string | number | undefined;
+    floating: boolean | undefined;
+    dense: boolean | undefined;
+    showSettings: boolean | undefined;
+    showFormActions: boolean | undefined;
+    formEnhancements: FormEnhancements<Record<string, unknown>> | undefined;
+    formLoading: boolean | undefined;
+    formDisabled: boolean | undefined;
+    formReadonly: boolean | undefined;
+    formSize: "sm" | "md" | "lg" | undefined;
+};
+export interface BioTemplateExperimentWorkspaceStatusProps {
+    status?: {
+        loading?: boolean;
+        saving?: boolean;
+        error?: string | null;
+        hasExperiment?: boolean;
+        currentExperimentId?: number;
+        lastLoadedAt?: Date | null;
+        lastSavedAt?: Date | null;
+    };
+    loading?: boolean;
+    error?: string | null;
+    hasExperiment?: boolean;
+    currentExperimentId?: number;
+    lastLoadedAt?: Date | null;
+    lastSavedAt?: Date | null;
+}
+export interface ResolvedBioTemplateExperimentStatus {
+    loading: boolean;
+    error: string | null | undefined;
+    hasExperiment: boolean;
+    currentExperimentId: number | undefined;
+    lastLoadedAt: Date | null | undefined;
+    lastSavedAt: Date | null | undefined;
+}
+/**
+ * Merges BioTemplateExperimentWorkspaceView's grouped `status` prop over its individual
+ * `loading`/`error`/`hasExperiment`/... props: `status` wins whenever the corresponding field
+ * on it is set, otherwise the flat prop (or its default) is used. Centralizes the six
+ * independent fallback rules generated plugin pages rely on when they pass a request/experiment
+ * `status` object instead of wiring each field by hand.
+ */
+export declare function bioTemplateExperimentWorkspaceProps(props: BioTemplateExperimentWorkspaceStatusProps): ResolvedBioTemplateExperimentStatus;
+export interface BioTemplatePackWorkspacePassthroughProps {
+    message?: string;
+    dense?: boolean;
+    readonly?: boolean;
+    showStatus?: boolean;
+    showTemplateSummary?: boolean;
+    loadLabel?: string;
+    resetLabel?: string;
+    saveLabel?: string;
+}
+/**
+ * Assembles the prop object BioTemplatePackWorkspaceView binds onto the
+ * BioTemplateExperimentWorkspaceView it wraps: its own display props passed straight through,
+ * plus the pack-derived `target`/`label`/`status`/`actions` computed by the caller.
+ */
+export declare function bioTemplatePackWorkspaceProps<TTarget, TStatus, TActions>(props: BioTemplatePackWorkspacePassthroughProps, derived: {
+    target: TTarget;
+    label: string;
+    status: TStatus;
+    actions: TActions;
+}): {
+    target: TTarget;
+    kind: "collection";
+    label: string;
+    message: string | undefined;
+    status: TStatus;
+    actions: TActions;
+    dense: boolean | undefined;
+    readonly: boolean | undefined;
+    showStatus: boolean | undefined;
+    showTemplateSummary: boolean | undefined;
+    loadLabel: string | undefined;
+    resetLabel: string | undefined;
+    saveLabel: string | undefined;
+};
+export interface BioTemplatePresetWorkspaceOptionsProps<TOptions extends ControlWorkspaceOptions> {
+    workspaceOptions?: TOptions;
+    initialValues?: Record<string, unknown>;
+    modelValue?: Record<string, unknown>;
+    values?: Record<string, unknown>;
+}
+/**
+ * Resolves BioTemplatePresetWorkspaceView's `workspaceOptions`/`initialValues`/`modelValue`/
+ * `values` props into the single options object `useBioTemplatePresetWorkspace()` needs,
+ * reusing the same base/initialValues/external-values layering as {@link controlWorkspaceProps}.
+ */
+export declare function bioTemplatePresetWorkspaceProps<TOptions extends ControlWorkspaceOptions>(props: BioTemplatePresetWorkspaceOptionsProps<TOptions>): {
+    externalValues: Record<string, unknown> | undefined;
+    resolvedWorkspaceOptions: TOptions;
+};

package/dist/{composables-CKxOcvgh.js → composables-C8mmD5ta.js}

@@ -1,7 +1,7 @@
-import { r as useRequestSyncState } from "./EmptyState-p90quq8Z.js";
-import { B as currentExperimentFromContext, U as resolveCurrentExperimentId, V as getInjectedPlatformContext, et as useEventStream } from "./useControlSchema-CXhxTul7.js";
+import { r as useRequestSyncState } from "./EmptyState-NBqf2_8z.js";
+import { B as currentExperimentFromContext, U as resolveCurrentExperimentId, V as getInjectedPlatformContext, et as useEventStream, lt as PLUGIN_SECRET_FORMAT_KEY } from "./useControlSchema-_OVhavKq.js";
 import { i as useAuthStore, n as authenticationRequiredError, o as useSettingsStore, r as useApi, t as AuthenticationRequiredError } from "./useApi-CDBq6z23.js";
-import { i as usePlatformContext } from "./useFormBuilder-CuOFB3aP.js";
+import { i as usePlatformContext } from "./useFormBuilder-Bd714C7y.js";
 import { computed, getCurrentInstance, onMounted, onUnmounted, ref, shallowRef, toValue, watch } from "vue";
 import axios from "axios";
 //#region src/composables/useAuth.ts
@@ -506,7 +506,11 @@ function defaultTransformError(error) {
 * const handleSubmit = () => submit(new FormData(formRef.value))
 * ```
 */
-/** Wraps an async function with reactive loading, error, and success state plus optional auto-execute. */
+/**
+* Wraps an async function with reactive loading, error, and success state plus optional auto-execute.
+*
+* @deprecated Unused by the MINT platform and scheduled for removal in MINT 1.3; use `useRequestSyncState()` instead.
+*/
 function useAsync(asyncFn, options = {}) {
 	const { initialData = null, immediate = false, immediateArgs = [], transformError = defaultTransformError, onSuccess, onError, resetOnExecute = false } = options;
 	const data = ref(initialData);
@@ -778,7 +782,11 @@ function parseAnalysisArtifactTarget(query) {
 }
 //#endregion
 //#region src/composables/useCommandHistory.ts
-/** Generic command-stack state for plugin editors with undo/redo controls. */
+/**
+* Generic command-stack state for plugin editors with undo/redo controls.
+*
+* @deprecated Unused by the MINT platform and scheduled for removal in MINT 1.3; keep command stacks plugin-local.
+*/
 function useCommandHistory(options = {}) {
 	const maxDepth = Math.max(1, options.maxDepth ?? 50);
 	const undoStack = ref([]);
@@ -841,7 +849,11 @@ function isPromiseLike(value) {
 }
 //#endregion
 //#region src/composables/useOptimisticMutation.ts
-/** Run async mutations with optional optimistic local updates and rollback. */
+/**
+* Run async mutations with optional optimistic local updates and rollback.
+*
+* @deprecated Unused by the MINT platform and scheduled for removal in MINT 1.3; use `useRequestSyncState()` instead.
+*/
 function useOptimisticMutation(options) {
 	const loading = shallowRef(false);
 	const error = ref(null);
@@ -902,7 +914,11 @@ function readErrorMessage$1(value) {
 }
 //#endregion
 //#region src/composables/useResourceCrud.ts
-/** Common list/create/update/delete state wrapper for generated plugin clients. */
+/**
+* Common list/create/update/delete state wrapper for generated plugin clients.
+*
+* @deprecated Unused by the MINT platform and scheduled for removal in MINT 1.3; use `useGeneratedPluginClient()` instead.
+*/
 function useResourceCrud(options) {
 	const items = ref([...options.initialItems ?? []]);
 	const loading = shallowRef(false);
@@ -1069,7 +1085,11 @@ var PLATE_DIMENSIONS = {
 		cols: 24
 	}
 };
-/** Pointer painting/rectangle selection state for WellPlate-based editors. */
+/**
+* Pointer painting/rectangle selection state for WellPlate-based editors.
+*
+* @deprecated Unused by the MINT platform and scheduled for removal in MINT 1.3; use `useWellPlateEditor()` instead.
+*/
 function useWellPainting(options) {
 	const activeMode = ref(options.initialMode ?? "select");
 	const activePayload = ref(options.initialPayload);
@@ -1182,7 +1202,11 @@ function indexToRowLabel$1(index) {
 }
 //#endregion
 //#region src/composables/useWellPlateAdapter.ts
-/** Convert domain rows into WellPlate's wells prop without hand-written adapters. */
+/**
+* Convert domain rows into WellPlate's wells prop without hand-written adapters.
+*
+* @deprecated Unused by the MINT platform and scheduled for removal in MINT 1.3; use `useWellPlateEditor()` instead.
+*/
 function useWellPlateAdapter(options) {
 	return { wells: computed(() => createWellPlateWells(toValue(options.entries), options)) };
 }
@@ -1268,7 +1292,11 @@ function indexToRowLabel(index) {
 }
 //#endregion
 //#region src/composables/useWellPlateValidation.ts
-/** Rule-driven validation state for WellPlate layout/design screens. */
+/**
+* Rule-driven validation state for WellPlate layout/design screens.
+*
+* @deprecated Unused by the MINT platform and scheduled for removal in MINT 1.3; use `useWellPlateEditor()` instead.
+*/
 function useWellPlateValidation(options) {
 	const warnings = computed(() => runWellPlateValidation(toValue(options.context), toValue(options.rules)));
 	return {
@@ -1635,6 +1663,24 @@ function usePluginClient(client) {
 	return client;
 }
 var PLATFORM_OWNED_SETTINGS_KEY = "allowed_experiment_types";
+/**
+* Secret settings travel as `{ "$secret": "<id>" }` references, so an untouched
+* secret round-trips without ever exposing its value. Declaring the format on
+* every write keeps a `null` unambiguous: it clears the stored secret instead of
+* meaning "unchanged", which is what the deprecated placeholder form meant.
+*/
+function withSecretFormat(payload, secretFormat) {
+	if (!secretFormat) return payload;
+	return {
+		...payload,
+		[PLUGIN_SECRET_FORMAT_KEY]: secretFormat
+	};
+}
+function responseSecretFormat(response) {
+	if (!response || typeof response !== "object") return null;
+	const format = response[PLUGIN_SECRET_FORMAT_KEY];
+	return typeof format === "string" && format ? format : null;
+}
 function cloneRecord(value) {
 	return JSON.parse(JSON.stringify(value));
 }
@@ -1672,6 +1718,7 @@ function usePluginSettings(options = {}) {
 	const values = ref({});
 	const savedValues = shallowRef({});
 	const revision = ref(null);
+	const secretFormat = ref(null);
 	const request = useRequestSyncState("Plugin settings request failed.");
 	const isLoading = ref(false);
 	const isSaving = ref(false);
@@ -1692,11 +1739,12 @@ function usePluginSettings(options = {}) {
 	function setValues(nextValues) {
 		values.value = cloneRecord(nextValues);
 	}
-	function applyLoaded(nextValues, nextRevision) {
+	function applyLoaded(nextValues, nextRevision, nextSecretFormat = secretFormat.value) {
 		const cloned = cloneRecord(nextValues);
 		values.value = cloned;
 		savedValues.value = cloneRecord(cloned);
 		revision.value = nextRevision;
+		secretFormat.value = nextSecretFormat;
 	}
 	async function load() {
 		isLoading.value = true;
@@ -1708,7 +1756,7 @@ function usePluginSettings(options = {}) {
 				success: "load",
 				errorMessage: "Failed to load plugin settings"
 			});
-			applyLoaded(responseSettingsPayload(response), responseSettingsRevision(response));
+			applyLoaded(responseSettingsPayload(response), responseSettingsRevision(response), responseSecretFormat(response));
 		} catch {} finally {
 			isLoading.value = false;
 		}
@@ -1725,7 +1773,7 @@ function usePluginSettings(options = {}) {
 				const typedKeys = [...dirtyKeys].filter((key) => key !== PLATFORM_OWNED_SETTINGS_KEY);
 				let nextRevision = revision.value;
 				if (typedKeys.length) {
-					response = await request.run(() => platformApi.patch(`/plugins/${encodeURIComponent(resolvedPluginName.value)}/config`, { config: topLevelSettingsPatch(payload, typedKeys) }), {
+					response = await request.run(() => platformApi.patch(`/plugins/${encodeURIComponent(resolvedPluginName.value)}/config`, { config: withSecretFormat(topLevelSettingsPatch(payload, typedKeys), secretFormat.value) }), {
 						success: "save",
 						errorMessage: "Failed to save plugin settings"
 					});
@@ -1739,16 +1787,16 @@ function usePluginSettings(options = {}) {
 					nextRevision = responseSettingsRevision(response) ?? nextRevision;
 				}
 				if (!response) return true;
-				applyLoaded(responseSettingsPayload(response), nextRevision);
+				applyLoaded(responseSettingsPayload(response), nextRevision, responseSecretFormat(response) ?? secretFormat.value);
 				return true;
 			} else {
 				const ifMatch = revision.value ? { headers: { "If-Match": `"${revision.value}"` } } : void 0;
-				response = await request.run(() => pluginApi.put("/settings", payload, ifMatch), {
+				response = await request.run(() => pluginApi.put("/settings", withSecretFormat(payload, secretFormat.value), ifMatch), {
 					success: "save",
 					errorMessage: "Failed to save plugin settings"
 				});
 			}
-			applyLoaded(responseSettingsPayload(response), responseSettingsRevision(response) ?? revision.value);
+			applyLoaded(responseSettingsPayload(response), responseSettingsRevision(response) ?? revision.value, responseSecretFormat(response) ?? secretFormat.value);
 			return true;
 		} catch {
 			return false;
@@ -1900,4 +1948,4 @@ function useCurrentExperiment(options = {}) {
 //#endregion
 export { useAsync as A, createPluginResourceClient as C, buildAnalysisArtifactTargetQuery as D, useCommandHistory as E, resolvePluginFrontendBase as M, usePasskey as N, parseAnalysisArtifactTarget as O, useAuth as P, wellIdsInRectangle as S, useOptimisticMutation as T, createWellPlateWells as _, pluginFormDataFromPayload as a, useWellPainting as b, usePluginClient as c, buildPluginEndpointUrl as d, resolvePluginBaseUrl as f, createRowConditions as g, createColumnConditions as h, getPluginPageSelectorItems as i, useAsyncBatch as j, usePluginConfig as k, usePluginEventStream as l, useWellPlateValidation as m, downloadBlob as n, uploadPluginEndpoint as o, runWellPlateValidation as p, downloadPluginEndpoint as r, useCurrentExperiment as s, createPluginClient as t, usePluginSettings as u, useWellPlateAdapter as v, useResourceCrud as w, wellIdToCoordinate as x, coordinateToWellId as y };
 
-//# sourceMappingURL=composables-CKxOcvgh.js.map
+//# sourceMappingURL=composables-C8mmD5ta.js.map