@morscherlab/mint-sdk 1.0.56 → 1.0.58

package/dist/types/analysisArtifactTypes.d.ts

@@ -0,0 +1,133 @@
+import { TreeNode } from './componentLabTypes';
+import { SummaryData } from './componentWorkflowTypes';
+/** Result schema identifier for file-backed analysis artifacts. */
+export declare const ANALYSIS_FILE_ARTIFACT_SCHEMA = "mint.analysis_file.v1";
+/** Known artifact lifecycle states; kept open for forward compatibility. */
+export type AnalysisArtifactStatus = 'active' | 'archived' | (string & {});
+/** Status filter vocabulary for artifact lists. */
+export type AnalysisArtifactStatusFilter = 'active' | 'archived' | 'all';
+/** Summary row returned by GET /experiments/{id}/analysis-artifacts. */
+export interface AnalysisArtifactSummary {
+    id: number;
+    experiment_id: number;
+    plugin_id: string;
+    artifact_key: string;
+    display_name: string;
+    note?: string | null;
+    status: AnalysisArtifactStatus;
+    result_keys: string[];
+    created_at?: string | null;
+    updated_at?: string | null;
+    archived_at?: string | null;
+    archived_by?: number | null;
+}
+/** Full artifact returned by GET /experiments/{id}/analysis-artifacts/{artifactId}. */
+export interface AnalysisArtifactDetail extends AnalysisArtifactSummary {
+    result: Record<string, unknown>;
+    tree: TreeNode[];
+    summary: SummaryData | null;
+}
+/** Response of GET /experiments/{id}/analysis-artifacts. */
+export interface AnalysisArtifactListResponse {
+    artifacts: AnalysisArtifactSummary[];
+}
+/** Body of PATCH /experiments/{id}/analysis-artifacts/{artifactId}. */
+export interface AnalysisArtifactMetadataUpdate {
+    display_name?: string;
+    /** undefined = keep, string = set, null = clear. */
+    note?: string | null;
+}
+/** How a save payload should be applied by the plugin backend. */
+export type ArtifactSaveMode = 'create' | 'upsert' | 'update';
+/** Where file content comes from when a plugin uses ArtifactSaveDialog. */
+export type ArtifactFileSource = 'upload' | 'handler';
+interface ArtifactSavePayloadBase {
+    experimentId: number;
+    artifactKey: string;
+}
+/**
+ * JSON artifact save — handler maps to save_analysis_artifact, which upserts by key.
+ * That call only assigns display_name/note when they are provided, and cannot clear
+ * either; use the metadata PATCH (useAnalysisArtifacts.updateMetadata) for that.
+ */
+export interface JsonArtifactSavePayload extends ArtifactSavePayloadBase {
+    kind: 'json';
+    mode: 'create' | 'upsert';
+    result: Record<string, unknown>;
+    displayName?: string;
+    note?: string;
+}
+/** File artifact create — handler maps to save_analysis_file_artifact (create-only: a reused key conflicts). */
+export interface FileArtifactCreatePayload extends ArtifactSavePayloadBase {
+    kind: 'file';
+    mode: 'create';
+    file: File;
+    /** Maps to the Python `kind=` argument (defaults to "file" backend-side). */
+    fileKind: string;
+    filename?: string;
+    displayName?: string;
+    note?: string;
+    contentType?: string;
+    metadata?: Record<string, unknown>;
+}
+/**
+ * File artifact replacement — handler maps to update_analysis_file_artifact
+ * (transactional CAS replace). `kind` and `filename` are immutable backend-side, so
+ * `fileKind` echoes the artifact's existing kind and no filename is carried. `note`
+ * is three-state: omitted preserves, null clears, a string sets. `metadata` REPLACES
+ * the previous result metadata rather than merging, so it always carries the full
+ * intended map — omitting it clears whatever was there.
+ */
+export interface FileArtifactUpdatePayload extends ArtifactSavePayloadBase {
+    kind: 'file';
+    mode: 'update';
+    file: File;
+    fileKind: string;
+    note?: string | null;
+    contentType?: string;
+    metadata?: Record<string, unknown>;
+}
+/**
+ * File artifact create where the plugin handler produces the bytes itself.
+ * This is intended for server-side serialization of in-memory analysis state;
+ * the browser neither fabricates nor uploads a placeholder File.
+ */
+export interface HandlerFileArtifactCreatePayload extends ArtifactSavePayloadBase {
+    kind: 'file';
+    mode: 'create';
+    source: 'handler';
+    fileKind: string;
+    displayName?: string;
+    note?: string;
+    metadata?: Record<string, unknown>;
+}
+/** File artifact replacement where the plugin handler produces the bytes itself. */
+export interface HandlerFileArtifactUpdatePayload extends ArtifactSavePayloadBase {
+    kind: 'file';
+    mode: 'update';
+    source: 'handler';
+    fileKind: string;
+    note?: string | null;
+    metadata?: Record<string, unknown>;
+}
+export type ArtifactSavePayload = JsonArtifactSavePayload | FileArtifactCreatePayload | FileArtifactUpdatePayload;
+/** Payloads accepted when `ArtifactSaveDialog.fileSource` is `handler`. */
+export type HandlerArtifactSavePayload = JsonArtifactSavePayload | HandlerFileArtifactCreatePayload | HandlerFileArtifactUpdatePayload;
+/** Every payload variant the dialog can emit across both file sources. */
+export type ArtifactSaveDialogPayload = ArtifactSavePayload | HandlerFileArtifactCreatePayload | HandlerFileArtifactUpdatePayload;
+/** Optional handler result; cleanupPending surfaces AnalysisFileArtifactUpdate.cleanup_pending. */
+export interface ArtifactSaveResult {
+    artifact?: AnalysisArtifactSummary;
+    cleanupPending?: boolean;
+}
+/**
+ * Plugin-supplied save handler. The dialog never writes to the platform;
+ * the handler forwards the payload to the plugin backend, which calls
+ * save_analysis_artifact / save_analysis_file_artifact / update_analysis_file_artifact.
+ */
+export type ArtifactSaveHandler = (payload: ArtifactSavePayload) => Promise<ArtifactSaveResult | void>;
+/** Save handler paired with `ArtifactSaveDialog.fileSource="handler"`. */
+export type HandlerArtifactSaveHandler = (payload: HandlerArtifactSavePayload) => Promise<ArtifactSaveResult | void>;
+/** Handler accepted by ArtifactSaveDialog; `fileSource` selects the payload family. */
+export type ArtifactSaveDialogHandler = ArtifactSaveHandler | HandlerArtifactSaveHandler;
+export {};

package/dist/types/index.d.ts

@@ -1,4 +1,6 @@
 export type { ContainerDirection, ButtonVariant, ButtonSize, InputType, ModalSize, ModalVariant, AlertType, Toast, TabItem, TabItemInput, OptionPrimitive, SelectOption, SelectOptionInput, RadioOption, RadioOptionInput, FormFieldProps, SidebarBadgeTone, SidebarToolSection, SidebarToolSectionAction, CollapsibleState, TopBarVariant, TopBarSettingsConfig, PillNavOption, PillNavOptionInput, PillNavItem, PillNavItemInput, PageSelectorItem, PageSelectorItemInput, PluginSwitcherPlugin, PluginSwitcherInfo, AccountMenuItem, WellPlateFormat, WellState, WellPlateSelectionMode, WellPlateSize, WellShape, Well, HeatmapColorScale, HeatmapConfig, SlotPosition, WellExtendedData, WellEditData, WellEditField, WellSampleDropData, WellSampleDropContext, WellSampleDropParser, WellLegendItem, PlateCondition, ColumnCondition, RowCondition, Rack, RackSampleDropContext, RackSampleDropMapper, SampleType, PlateMap, PlateMapEditorState, ProtocolStepType, ProtocolStepStatus, ProtocolStep, SampleGroup, GroupItem, FileUploaderMode, SegmentedOption, SegmentedOptionInput, SegmentedControlVariant, SegmentedControlSize, MultiSelectOption, MultiSelectOptionInput, MultiSelectSize, PillVariant, PillColor, PillSize, CalendarSelectionMode, CalendarMarker, CalendarDayContext, SortDirection, SortState, DataFrameColumn, PaginationState, SpinnerSize, SpinnerVariant, DividerSpacing, StatusType, ProgressVariant, ProgressSize, AvatarSize, EmptyStateColor, EmptyStateSize, BreadcrumbItem, BreadcrumbItemInput, TooltipPosition, ConfirmVariant, SettingsTab, SettingsTabInput, SettingsModalLayout, SettingsGroup, SettingsModalSchema, SettingsUserType, SettingsAudience, SettingsAudienceInput, NumberNotation, UnitOption, WizardStep, WizardStepState, AuditEntryType, AuditEntry, BatchItemStatus, BatchItem, BatchSummary, TimePickerFormat, TimeRange, ScheduleView, ScheduleEventStatus, ScheduleEvent, ScheduleBlockedSlot, ScheduleSlotContext, ScheduleEventCreateContext, ScheduleEventUpdateContext, SummarySectionItem, SummarySection, SummaryData, ResourceStatus, ResourceSpec, MoleculeData, ExperimentStatus, DatePreset, ExperimentSortField, ExperimentTypeOption, ExperimentSummary, ExperimentListResponse, ExperimentFilters, FitState, FitResultSummary, StorageCondition, ReagentColumn, Reagent, TreeNodeType, BadgeVariant, TreeNode, } from './components';
+export type { AnalysisArtifactStatus, AnalysisArtifactStatusFilter, AnalysisArtifactSummary, AnalysisArtifactDetail, AnalysisArtifactListResponse, AnalysisArtifactMetadataUpdate, ArtifactSaveMode, ArtifactFileSource, JsonArtifactSavePayload, FileArtifactCreatePayload, FileArtifactUpdatePayload, HandlerFileArtifactCreatePayload, HandlerFileArtifactUpdatePayload, ArtifactSavePayload, HandlerArtifactSavePayload, ArtifactSaveDialogPayload, ArtifactSaveResult, ArtifactSaveHandler, HandlerArtifactSaveHandler, ArtifactSaveDialogHandler, } from './analysisArtifactTypes';
+export { ANALYSIS_FILE_ARTIFACT_SCHEMA } from './analysisArtifactTypes';
 export type { JobListPayload, JobProgress, JobSnapshotPayload, JobState, JobStateInput, JobStatus, JobStreamData, } from './jobs';
 export type { InstrumentAlert, InstrumentAlertBody, InstrumentAlertLevel, InstrumentState, InstrumentStatus, SampleInfo, SampleInfo as InstrumentSampleInfo, SequenceProgress, } from './instrument';
 export type { LcmsContainerType, LcmsPolarity, LcmsSequenceItem, LcmsSequenceTableColumn, } from '../lcms';

package/dist/types/index.js

@@ -0,0 +1,2 @@
+import { t as ANALYSIS_FILE_ARTIFACT_SCHEMA } from "../analysisArtifactTypes-Cu40dzSG.js";
+export { ANALYSIS_FILE_ARTIFACT_SCHEMA };

package/dist/{useJobsStatusTray-CVecN6Ao.js → useAnalysisArtifacts-Ob8UtVwl.js}

@@ -4736,6 +4736,161 @@ function useJobsStatusTray(options = {}) {
 	};
 }
 //#endregion
-export { useTheme as $, useExpansionSet as A, extractSamplesFromDesignData as B, useExperimentSave as C, currentExperimentFromContext as D, useExperimentData as E, detectDelimiter as F, unwrapExperimentDesignData as G, parseCSV as H, parseDelimitedText as I, useDoseCalculator as J, DEFAULT_COLORS as K, readFileAsText as L, deriveShade as M, hexToHsl as N, getInjectedPlatformContext as O, hslToHex as P, useAppExperiment as Q, useFileImport as R, useTemplateCollection as S, useExperimentSamples as T, extractSampleNamesFromDesignData as U, useAutoGroup as V, extractSampleOptionsFromDesignData as W, useMobileSupportGate as X, DEFAULT_MOBILE_VIEWPORT_QUERY as Y, APP_EXPERIMENT_KEY as Z, useBioTemplateWorkspace as _, normalizeJobPercent as a, useSortedItems as at, useBioTemplateComponents as b, useProtocolTemplates as c, generateDilutionSeries as d, useToast as et, useReagentSeries as f, useBioTemplatePackWorkspace as g, useBioTemplatePresetWorkspace as h, jobStatusLabel as i, compareSortValues as it, useSampleGroups as j, resolveCurrentExperimentId as k, DEFAULT_PRESETS as l, useRackEditor as m, isActiveJobStatus as n, normalizeSearchQuery as nt, normalizeJobState as o, useGroupAssignment as p, useWellPlateEditor as q, isTerminalJobStatus as r, useTextSearch as rt, resolveJobCapabilities as s, useJobsStatusTray as t, candidateMatchesSearch as tt, DEFAULT_UNITS as u, getBioTemplateComponentProps as v, useScheduleDrag as w, useBioTemplateControls as x, toBioTemplateComponentPropsByComponent as y, validateImportFile as z };
+//#region src/composables/useAnalysisArtifacts.ts
+/** Lists and manages analysis artifacts through the user-facing platform API. */
+function useAnalysisArtifacts(options = {}) {
+	const injectedContext = getInjectedPlatformContext();
+	const api = useApi({ baseUrl: options.apiBaseUrl ?? injectedContext?.platformApiUrl });
+	const currentExperimentId = computed(() => toValue(options.experimentId) ?? resolveCurrentExperimentId(injectedContext));
+	const hasCurrentExperiment = computed(() => currentExperimentId.value !== void 0);
+	const scopePluginId = computed(() => toValue(options.pluginId) ?? null);
+	const request = useRequestSyncState("Analysis artifact request failed.");
+	const fetchedArtifacts = ref([]);
+	const selectedDetail = ref(null);
+	const loadingCount = ref(0);
+	const mutatingCount = ref(0);
+	const isLoading = computed(() => loadingCount.value > 0);
+	const isMutating = computed(() => mutatingCount.value > 0);
+	const search = ref("");
+	const statusFilter = ref("active");
+	const pluginFilter = ref(null);
+	const needsArchived = computed(() => Boolean(toValue(options.includeArchived)) || statusFilter.value !== "active");
+	const artifacts = computed(() => scopePluginId.value ? fetchedArtifacts.value.filter((artifact) => artifact.plugin_id === scopePluginId.value) : fetchedArtifacts.value);
+	const visibleArtifacts = computed(() => {
+		const query = search.value.trim().toLowerCase();
+		return artifacts.value.filter((artifact) => {
+			if (statusFilter.value !== "all" && artifact.status !== statusFilter.value) return false;
+			if (pluginFilter.value && artifact.plugin_id !== pluginFilter.value) return false;
+			if (!query) return true;
+			return artifact.display_name.toLowerCase().includes(query) || artifact.artifact_key.toLowerCase().includes(query);
+		});
+	});
+	let listToken = 0;
+	let detailToken = 0;
+	const hasRequestedList = ref(false);
+	function currentExperimentIdOrError(action) {
+		const id = currentExperimentId.value;
+		if (id === void 0) {
+			request.setError(`No current experiment is selected for ${action}`);
+			return;
+		}
+		return id;
+	}
+	function replaceArtifact(summary) {
+		const index = fetchedArtifacts.value.findIndex((artifact) => artifact.id === summary.id);
+		if (index >= 0) fetchedArtifacts.value.splice(index, 1, summary);
+	}
+	async function list() {
+		const experimentId = currentExperimentIdOrError("listing analysis artifacts");
+		if (experimentId === void 0) {
+			fetchedArtifacts.value = [];
+			return [];
+		}
+		const token = ++listToken;
+		hasRequestedList.value = true;
+		loadingCount.value += 1;
+		request.clearError();
+		try {
+			const data = await api.get(`/experiments/${experimentId}/analysis-artifacts?include_archived=${needsArchived.value}`);
+			if (token !== listToken) return artifacts.value;
+			fetchedArtifacts.value = [...data?.artifacts ?? []];
+			request.markLoaded();
+			return artifacts.value;
+		} catch (err) {
+			if (token !== listToken) return [];
+			request.setError(err);
+			fetchedArtifacts.value = [];
+			return [];
+		} finally {
+			loadingCount.value -= 1;
+		}
+	}
+	async function getDetail(artifactId) {
+		const experimentId = currentExperimentIdOrError("loading an analysis artifact");
+		if (experimentId === void 0) return null;
+		const token = ++detailToken;
+		loadingCount.value += 1;
+		request.clearError();
+		try {
+			const detail = await api.get(`/experiments/${experimentId}/analysis-artifacts/${artifactId}`);
+			if (token !== detailToken) return null;
+			selectedDetail.value = detail;
+			request.markLoaded();
+			return detail;
+		} catch (err) {
+			if (token !== detailToken) return null;
+			request.setError(err);
+			return null;
+		} finally {
+			loadingCount.value -= 1;
+		}
+	}
+	async function mutate(action, operation) {
+		const experimentId = currentExperimentIdOrError(action);
+		if (experimentId === void 0) return null;
+		mutatingCount.value += 1;
+		request.clearError();
+		try {
+			const summary = await operation(experimentId);
+			replaceArtifact(summary);
+			request.markSaved();
+			return summary;
+		} catch (err) {
+			request.setError(err);
+			return null;
+		} finally {
+			mutatingCount.value -= 1;
+		}
+	}
+	async function updateMetadata(artifactId, updates) {
+		return mutate("updating artifact metadata", (experimentId) => api.patch(`/experiments/${experimentId}/analysis-artifacts/${artifactId}`, updates));
+	}
+	async function archive(artifactId) {
+		return mutate("archiving an analysis artifact", (experimentId) => api.post(`/experiments/${experimentId}/analysis-artifacts/${artifactId}/archive`));
+	}
+	async function restore(artifactId) {
+		return mutate("restoring an analysis artifact", (experimentId) => api.post(`/experiments/${experimentId}/analysis-artifacts/${artifactId}/restore`));
+	}
+	function hasArtifactKey(artifactKey) {
+		return artifacts.value.some((artifact) => artifact.artifact_key === artifactKey);
+	}
+	/** Drop experiment-scoped state and orphan every in-flight response. */
+	function clear() {
+		listToken += 1;
+		detailToken += 1;
+		fetchedArtifacts.value = [];
+		selectedDetail.value = null;
+		request.clearError();
+	}
+	watch([currentExperimentId, needsArchived], ([experimentId], [previousExperimentId]) => {
+		if (experimentId !== previousExperimentId) clear();
+		if (experimentId === void 0) return;
+		if (options.immediate || hasRequestedList.value) list();
+	}, { immediate: options.immediate });
+	return {
+		artifacts,
+		visibleArtifacts,
+		selectedDetail,
+		currentExperimentId,
+		hasCurrentExperiment,
+		isLoading,
+		isMutating,
+		error: request.error,
+		lastLoadedAt: request.lastLoadedAt,
+		search,
+		statusFilter,
+		pluginFilter,
+		list,
+		refresh: list,
+		getDetail,
+		updateMetadata,
+		archive,
+		restore,
+		hasArtifactKey,
+		clear
+	};
+}
+//#endregion
+export { useAppExperiment as $, resolveCurrentExperimentId as A, validateImportFile as B, useTemplateCollection as C, useExperimentData as D, useExperimentSamples as E, hslToHex as F, extractSampleOptionsFromDesignData as G, useAutoGroup as H, detectDelimiter as I, useWellPlateEditor as J, unwrapExperimentDesignData as K, parseDelimitedText as L, useSampleGroups as M, deriveShade as N, currentExperimentFromContext as O, hexToHsl as P, APP_EXPERIMENT_KEY as Q, readFileAsText as R, useBioTemplateControls as S, useScheduleDrag as T, parseCSV as U, extractSamplesFromDesignData as V, extractSampleNamesFromDesignData as W, DEFAULT_MOBILE_VIEWPORT_QUERY as X, useDoseCalculator as Y, useMobileSupportGate as Z, useBioTemplatePackWorkspace as _, jobStatusLabel as a, compareSortValues as at, toBioTemplateComponentPropsByComponent as b, resolveJobCapabilities as c, DEFAULT_UNITS as d, useTheme as et, generateDilutionSeries as f, useBioTemplatePresetWorkspace as g, useRackEditor as h, isTerminalJobStatus as i, useTextSearch as it, useExpansionSet as j, getInjectedPlatformContext as k, useProtocolTemplates as l, useGroupAssignment as m, useJobsStatusTray as n, candidateMatchesSearch as nt, normalizeJobPercent as o, useSortedItems as ot, useReagentSeries as p, DEFAULT_COLORS as q, isActiveJobStatus as r, normalizeSearchQuery as rt, normalizeJobState as s, useAnalysisArtifacts as t, useToast as tt, DEFAULT_PRESETS as u, useBioTemplateWorkspace as v, useExperimentSave as w, useBioTemplateComponents as x, getBioTemplateComponentProps as y, useFileImport as z };
 
-//# sourceMappingURL=useJobsStatusTray-CVecN6Ao.js.map
+//# sourceMappingURL=useAnalysisArtifacts-Ob8UtVwl.js.map