@n8n/stores 2.32.2 → 2.34.0

package/dist/versions.store.d.mts

@@ -0,0 +1,384 @@
+import { t as ModalOpeners } from "./modalOpeners2.mjs";
+import * as pinia6 from "pinia";
+import * as vue440 from "vue";
+import { IVersionNotificationSettings } from "@n8n/api-types";
+import * as n8n_workflow5 from "n8n-workflow";
+import * as versionsApi from "@n8n/rest-api-client/api/versions";
+import { Version } from "@n8n/rest-api-client/api/versions";
+
+//#region src/versions.store.d.ts
+type SetVersionParams = {
+  versions: Version[];
+  currentVersion: string;
+};
+declare const SEMVER_REGEX: RegExp;
+declare const useVersionsStore: pinia6.StoreDefinition<"versions", Pick<{
+  currentVersion: vue440.Ref<versionsApi.Version | undefined, versionsApi.Version | undefined>;
+  latestVersion: vue440.ComputedRef<{
+    name: string;
+    nodes: {
+      name: string;
+      displayName: string;
+      icon: string;
+      iconUrl?: string | undefined;
+      defaults: n8n_workflow5.INodeParameters;
+      iconData: {
+        type: string;
+        icon?: string | undefined;
+        fileBuffer?: string | undefined;
+      };
+      typeVersion?: number | undefined;
+    }[];
+    createdAt: string;
+    description: string;
+    documentationUrl: string;
+    hasBreakingChange: boolean;
+    hasSecurityFix: boolean;
+    hasSecurityIssue: boolean;
+    securityIssueFixVersion: string;
+  }>;
+  nextVersions: vue440.Ref<{
+    name: string;
+    nodes: {
+      name: string;
+      displayName: string;
+      icon: string;
+      iconUrl?: string | undefined;
+      defaults: n8n_workflow5.INodeParameters;
+      iconData: {
+        type: string;
+        icon?: string | undefined;
+        fileBuffer?: string | undefined;
+      };
+      typeVersion?: number | undefined;
+    }[];
+    createdAt: string;
+    description: string;
+    documentationUrl: string;
+    hasBreakingChange: boolean;
+    hasSecurityFix: boolean;
+    hasSecurityIssue: boolean;
+    securityIssueFixVersion: string;
+  }[], versionsApi.Version[] | {
+    name: string;
+    nodes: {
+      name: string;
+      displayName: string;
+      icon: string;
+      iconUrl?: string | undefined;
+      defaults: n8n_workflow5.INodeParameters;
+      iconData: {
+        type: string;
+        icon?: string | undefined;
+        fileBuffer?: string | undefined;
+      };
+      typeVersion?: number | undefined;
+    }[];
+    createdAt: string;
+    description: string;
+    documentationUrl: string;
+    hasBreakingChange: boolean;
+    hasSecurityFix: boolean;
+    hasSecurityIssue: boolean;
+    securityIssueFixVersion: string;
+  }[]>;
+  hasVersionUpdates: vue440.ComputedRef<boolean>;
+  hasSignificantUpdates: vue440.ComputedRef<boolean>;
+  areNotificationsEnabled: vue440.ComputedRef<boolean>;
+  infoUrl: vue440.ComputedRef<string>;
+  fetchVersions: () => Promise<void>;
+  setVersions: (params: SetVersionParams) => void;
+  initialize: (settings: IVersionNotificationSettings) => void;
+  registerModalOpeners: (openers: ModalOpeners) => void;
+  checkForNewVersions: () => Promise<void>;
+  fetchWhatsNew: () => Promise<void>;
+  whatsNew: vue440.Ref<{
+    title: string;
+    calloutText: string;
+    footer: string;
+    items: {
+      id: number;
+      createdAt: string;
+      updatedAt: string | null;
+      publishedAt: string;
+      title: string;
+      content: string;
+    }[];
+    createdAt: string;
+    updatedAt: string | null;
+  }, versionsApi.WhatsNewSection | {
+    title: string;
+    calloutText: string;
+    footer: string;
+    items: {
+      id: number;
+      createdAt: string;
+      updatedAt: string | null;
+      publishedAt: string;
+      title: string;
+      content: string;
+    }[];
+    createdAt: string;
+    updatedAt: string | null;
+  }>;
+  whatsNewArticles: vue440.ComputedRef<{
+    id: number;
+    createdAt: string;
+    updatedAt: string | null;
+    publishedAt: string;
+    title: string;
+    content: string;
+  }[]>;
+  isWhatsNewArticleRead: (articleId: number) => boolean;
+  setWhatsNewArticleRead: (articleId: number) => void;
+  closeWhatsNewCallout: () => void;
+  shouldShowWhatsNewCallout: () => boolean;
+  dismissWhatsNewCallout: () => void;
+}, "currentVersion" | "nextVersions" | "whatsNew">, Pick<{
+  currentVersion: vue440.Ref<versionsApi.Version | undefined, versionsApi.Version | undefined>;
+  latestVersion: vue440.ComputedRef<{
+    name: string;
+    nodes: {
+      name: string;
+      displayName: string;
+      icon: string;
+      iconUrl?: string | undefined;
+      defaults: n8n_workflow5.INodeParameters;
+      iconData: {
+        type: string;
+        icon?: string | undefined;
+        fileBuffer?: string | undefined;
+      };
+      typeVersion?: number | undefined;
+    }[];
+    createdAt: string;
+    description: string;
+    documentationUrl: string;
+    hasBreakingChange: boolean;
+    hasSecurityFix: boolean;
+    hasSecurityIssue: boolean;
+    securityIssueFixVersion: string;
+  }>;
+  nextVersions: vue440.Ref<{
+    name: string;
+    nodes: {
+      name: string;
+      displayName: string;
+      icon: string;
+      iconUrl?: string | undefined;
+      defaults: n8n_workflow5.INodeParameters;
+      iconData: {
+        type: string;
+        icon?: string | undefined;
+        fileBuffer?: string | undefined;
+      };
+      typeVersion?: number | undefined;
+    }[];
+    createdAt: string;
+    description: string;
+    documentationUrl: string;
+    hasBreakingChange: boolean;
+    hasSecurityFix: boolean;
+    hasSecurityIssue: boolean;
+    securityIssueFixVersion: string;
+  }[], versionsApi.Version[] | {
+    name: string;
+    nodes: {
+      name: string;
+      displayName: string;
+      icon: string;
+      iconUrl?: string | undefined;
+      defaults: n8n_workflow5.INodeParameters;
+      iconData: {
+        type: string;
+        icon?: string | undefined;
+        fileBuffer?: string | undefined;
+      };
+      typeVersion?: number | undefined;
+    }[];
+    createdAt: string;
+    description: string;
+    documentationUrl: string;
+    hasBreakingChange: boolean;
+    hasSecurityFix: boolean;
+    hasSecurityIssue: boolean;
+    securityIssueFixVersion: string;
+  }[]>;
+  hasVersionUpdates: vue440.ComputedRef<boolean>;
+  hasSignificantUpdates: vue440.ComputedRef<boolean>;
+  areNotificationsEnabled: vue440.ComputedRef<boolean>;
+  infoUrl: vue440.ComputedRef<string>;
+  fetchVersions: () => Promise<void>;
+  setVersions: (params: SetVersionParams) => void;
+  initialize: (settings: IVersionNotificationSettings) => void;
+  registerModalOpeners: (openers: ModalOpeners) => void;
+  checkForNewVersions: () => Promise<void>;
+  fetchWhatsNew: () => Promise<void>;
+  whatsNew: vue440.Ref<{
+    title: string;
+    calloutText: string;
+    footer: string;
+    items: {
+      id: number;
+      createdAt: string;
+      updatedAt: string | null;
+      publishedAt: string;
+      title: string;
+      content: string;
+    }[];
+    createdAt: string;
+    updatedAt: string | null;
+  }, versionsApi.WhatsNewSection | {
+    title: string;
+    calloutText: string;
+    footer: string;
+    items: {
+      id: number;
+      createdAt: string;
+      updatedAt: string | null;
+      publishedAt: string;
+      title: string;
+      content: string;
+    }[];
+    createdAt: string;
+    updatedAt: string | null;
+  }>;
+  whatsNewArticles: vue440.ComputedRef<{
+    id: number;
+    createdAt: string;
+    updatedAt: string | null;
+    publishedAt: string;
+    title: string;
+    content: string;
+  }[]>;
+  isWhatsNewArticleRead: (articleId: number) => boolean;
+  setWhatsNewArticleRead: (articleId: number) => void;
+  closeWhatsNewCallout: () => void;
+  shouldShowWhatsNewCallout: () => boolean;
+  dismissWhatsNewCallout: () => void;
+}, "latestVersion" | "infoUrl" | "hasVersionUpdates" | "hasSignificantUpdates" | "areNotificationsEnabled" | "whatsNewArticles">, Pick<{
+  currentVersion: vue440.Ref<versionsApi.Version | undefined, versionsApi.Version | undefined>;
+  latestVersion: vue440.ComputedRef<{
+    name: string;
+    nodes: {
+      name: string;
+      displayName: string;
+      icon: string;
+      iconUrl?: string | undefined;
+      defaults: n8n_workflow5.INodeParameters;
+      iconData: {
+        type: string;
+        icon?: string | undefined;
+        fileBuffer?: string | undefined;
+      };
+      typeVersion?: number | undefined;
+    }[];
+    createdAt: string;
+    description: string;
+    documentationUrl: string;
+    hasBreakingChange: boolean;
+    hasSecurityFix: boolean;
+    hasSecurityIssue: boolean;
+    securityIssueFixVersion: string;
+  }>;
+  nextVersions: vue440.Ref<{
+    name: string;
+    nodes: {
+      name: string;
+      displayName: string;
+      icon: string;
+      iconUrl?: string | undefined;
+      defaults: n8n_workflow5.INodeParameters;
+      iconData: {
+        type: string;
+        icon?: string | undefined;
+        fileBuffer?: string | undefined;
+      };
+      typeVersion?: number | undefined;
+    }[];
+    createdAt: string;
+    description: string;
+    documentationUrl: string;
+    hasBreakingChange: boolean;
+    hasSecurityFix: boolean;
+    hasSecurityIssue: boolean;
+    securityIssueFixVersion: string;
+  }[], versionsApi.Version[] | {
+    name: string;
+    nodes: {
+      name: string;
+      displayName: string;
+      icon: string;
+      iconUrl?: string | undefined;
+      defaults: n8n_workflow5.INodeParameters;
+      iconData: {
+        type: string;
+        icon?: string | undefined;
+        fileBuffer?: string | undefined;
+      };
+      typeVersion?: number | undefined;
+    }[];
+    createdAt: string;
+    description: string;
+    documentationUrl: string;
+    hasBreakingChange: boolean;
+    hasSecurityFix: boolean;
+    hasSecurityIssue: boolean;
+    securityIssueFixVersion: string;
+  }[]>;
+  hasVersionUpdates: vue440.ComputedRef<boolean>;
+  hasSignificantUpdates: vue440.ComputedRef<boolean>;
+  areNotificationsEnabled: vue440.ComputedRef<boolean>;
+  infoUrl: vue440.ComputedRef<string>;
+  fetchVersions: () => Promise<void>;
+  setVersions: (params: SetVersionParams) => void;
+  initialize: (settings: IVersionNotificationSettings) => void;
+  registerModalOpeners: (openers: ModalOpeners) => void;
+  checkForNewVersions: () => Promise<void>;
+  fetchWhatsNew: () => Promise<void>;
+  whatsNew: vue440.Ref<{
+    title: string;
+    calloutText: string;
+    footer: string;
+    items: {
+      id: number;
+      createdAt: string;
+      updatedAt: string | null;
+      publishedAt: string;
+      title: string;
+      content: string;
+    }[];
+    createdAt: string;
+    updatedAt: string | null;
+  }, versionsApi.WhatsNewSection | {
+    title: string;
+    calloutText: string;
+    footer: string;
+    items: {
+      id: number;
+      createdAt: string;
+      updatedAt: string | null;
+      publishedAt: string;
+      title: string;
+      content: string;
+    }[];
+    createdAt: string;
+    updatedAt: string | null;
+  }>;
+  whatsNewArticles: vue440.ComputedRef<{
+    id: number;
+    createdAt: string;
+    updatedAt: string | null;
+    publishedAt: string;
+    title: string;
+    content: string;
+  }[]>;
+  isWhatsNewArticleRead: (articleId: number) => boolean;
+  setWhatsNewArticleRead: (articleId: number) => void;
+  closeWhatsNewCallout: () => void;
+  shouldShowWhatsNewCallout: () => boolean;
+  dismissWhatsNewCallout: () => void;
+}, "initialize" | "registerModalOpeners" | "fetchVersions" | "setVersions" | "checkForNewVersions" | "fetchWhatsNew" | "isWhatsNewArticleRead" | "setWhatsNewArticleRead" | "closeWhatsNewCallout" | "shouldShowWhatsNewCallout" | "dismissWhatsNewCallout">>;
+//#endregion
+export { SEMVER_REGEX, useVersionsStore };
+//# sourceMappingURL=versions.store.d.mts.map

package/dist/versions.store.mjs

@@ -0,0 +1,10 @@
+import "./constants2.mjs";
+import "./metaTagConfig2.mjs";
+import "./useRootStore2.mjs";
+import "./settings2.store.mjs";
+import "./invitation2.api.mjs";
+import "./onboarding2.api.mjs";
+import "./users2.store.mjs";
+import { n as useVersionsStore, t as SEMVER_REGEX } from "./versions2.store.mjs";
+
+export { SEMVER_REGEX, useVersionsStore };

package/dist/versions2.store.cjs

@@ -0,0 +1,230 @@
+const require_settings_store = require('./settings2.store.cjs');
+const require_constants = require('./constants2.cjs');
+const require_useRootStore = require('./useRootStore2.cjs');
+const require_users_store = require('./users2.store.cjs');
+let pinia = require("pinia");
+let vue = require("vue");
+let n8n_workflow = require("n8n-workflow");
+let __n8n_composables_useStorage = require("@n8n/composables/useStorage");
+let __n8n_composables_useTelemetry = require("@n8n/composables/useTelemetry");
+let __n8n_composables_useToast = require("@n8n/composables/useToast");
+let __n8n_frontend_constants_versions = require("@n8n/frontend-constants/versions");
+let __n8n_rest_api_client_api_versions = require("@n8n/rest-api-client/api/versions");
+__n8n_rest_api_client_api_versions = require_settings_store.__toESM(__n8n_rest_api_client_api_versions);
+
+//#region src/versions.store.ts
+/**
+* Semantic versioning 2.0.0, Regex from https://semver.org/
+* Capture groups: major, minor, patch, prerelease, buildmetadata
+*/
+const SEMVER_REGEX = /^(?<major>0|[1-9]\d*)\.(?<minor>0|[1-9]\d*)\.(?<patch>0|[1-9]\d*)(?:-(?<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
+const useVersionsStore = (0, pinia.defineStore)(require_constants.STORES.VERSIONS, () => {
+	const versionNotificationSettings = (0, vue.ref)({
+		enabled: false,
+		whatsNewEnabled: false,
+		endpoint: "",
+		whatsNewEndpoint: "",
+		infoUrl: ""
+	});
+	const nextVersions = (0, vue.ref)([]);
+	const currentVersion = (0, vue.ref)();
+	const whatsNew = (0, vue.ref)({
+		title: "",
+		createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+		updatedAt: null,
+		calloutText: "",
+		footer: "",
+		items: []
+	});
+	const whatsNewCallout = (0, vue.ref)();
+	const telemetry = (0, __n8n_composables_useTelemetry.useTelemetry)();
+	const { showToast, showMessage } = (0, __n8n_composables_useToast.useToast)();
+	const settingsStore = require_settings_store.useSettingsStore();
+	const usersStore = require_users_store.useUsersStore();
+	const warnModalOpenerMissing = (action) => {
+		if ({}.env.DEV) console.warn(`[versions.store] ${action} called before modal openers were registered; ignoring. Call registerModalOpeners() at app bootstrap.`);
+	};
+	const modalOpeners = (0, vue.ref)({
+		openModal: (name) => warnModalOpenerMissing(`openModal(${String(name)})`),
+		openModalWithData: (payload) => warnModalOpenerMissing(`openModalWithData(${String(payload.name)})`)
+	});
+	const registerModalOpeners = (openers) => {
+		modalOpeners.value = openers;
+	};
+	const readWhatsNewArticlesStorage = (0, __n8n_composables_useStorage.useStorage)(__n8n_frontend_constants_versions.LOCAL_STORAGE_READ_WHATS_NEW_ARTICLES);
+	const lastDismissedWhatsNewCalloutStorage = (0, __n8n_composables_useStorage.useStorage)(__n8n_frontend_constants_versions.LOCAL_STORAGE_DISMISSED_WHATS_NEW_CALLOUT);
+	const hasVersionUpdates = (0, vue.computed)(() => {
+		return settingsStore.settings.releaseChannel === "stable" && nextVersions.value.length > 0;
+	});
+	const hasSignificantUpdates = (0, vue.computed)(() => {
+		if (!hasVersionUpdates.value || !currentVersion.value || !latestVersion.value) return false;
+		if (currentVersion.value.hasSecurityIssue) return true;
+		const current = currentVersion.value.name.match(SEMVER_REGEX);
+		const latest = latestVersion.value.name.match(SEMVER_REGEX);
+		if (!current?.groups || !latest?.groups) return false;
+		if (Number(current.groups.major) !== Number(latest.groups.major)) return true;
+		const currentMinor = Number(current.groups.minor);
+		return Number(latest.groups.minor) - currentMinor >= 2;
+	});
+	const latestVersion = (0, vue.computed)(() => {
+		return nextVersions.value[0] ?? currentVersion.value;
+	});
+	const areNotificationsEnabled = (0, vue.computed)(() => {
+		return versionNotificationSettings.value.enabled;
+	});
+	const infoUrl = (0, vue.computed)(() => {
+		return versionNotificationSettings.value.infoUrl;
+	});
+	const readWhatsNewArticles = (0, vue.computed)(() => {
+		return readWhatsNewArticlesStorage.value ? (0, n8n_workflow.jsonParse)(readWhatsNewArticlesStorage.value, { fallbackValue: [] }) : [];
+	});
+	const lastDismissedWhatsNewCallout = (0, vue.computed)(() => {
+		return lastDismissedWhatsNewCalloutStorage.value ? (0, n8n_workflow.jsonParse)(lastDismissedWhatsNewCalloutStorage.value, { fallbackValue: [] }) : [];
+	});
+	const whatsNewArticles = (0, vue.computed)(() => {
+		return whatsNew.value.items;
+	});
+	const fetchVersions = async () => {
+		try {
+			const { enabled, endpoint } = versionNotificationSettings.value;
+			if (enabled && endpoint) {
+				const rootStore = require_useRootStore.useRootStore();
+				const current = rootStore.versionCli;
+				const instanceId = rootStore.instanceId;
+				setVersions({
+					versions: await __n8n_rest_api_client_api_versions.getNextVersions(endpoint, current, instanceId),
+					currentVersion: current
+				});
+			}
+		} catch (e) {
+			console.error("Failed to fetch versions:", e);
+		}
+	};
+	const setVersions = (params) => {
+		nextVersions.value = params.versions.filter((v) => v.name !== params.currentVersion);
+		currentVersion.value = params.versions.find((v) => v.name === params.currentVersion);
+	};
+	const setWhatsNew = (section) => {
+		whatsNew.value = section;
+	};
+	const setWhatsNewArticleRead = (articleId) => {
+		if (!readWhatsNewArticles.value.includes(articleId)) readWhatsNewArticlesStorage.value = JSON.stringify([...readWhatsNewArticles.value, articleId]);
+	};
+	const isWhatsNewArticleRead = (articleId) => {
+		return readWhatsNewArticles.value.includes(articleId);
+	};
+	const closeWhatsNewCallout = () => {
+		whatsNewCallout.value?.close();
+		whatsNewCallout.value = void 0;
+	};
+	const dismissWhatsNewCallout = () => {
+		lastDismissedWhatsNewCalloutStorage.value = JSON.stringify(whatsNewArticles.value.map((item) => item.id));
+	};
+	const shouldShowWhatsNewCallout = () => {
+		const createdAt = usersStore.currentUser?.createdAt;
+		let hasNewArticle = false;
+		if (createdAt) {
+			const userCreatedAt = new Date(createdAt).getTime();
+			hasNewArticle = whatsNewArticles.value.some((item) => {
+				return (item.updatedAt ? new Date(item.updatedAt).getTime() : 0) > userCreatedAt;
+			});
+		} else hasNewArticle = true;
+		const allArticlesDismissed = whatsNewArticles.value.every((item) => lastDismissedWhatsNewCallout.value.includes(item.id));
+		return hasNewArticle && !allArticlesDismissed;
+	};
+	const fetchWhatsNew = async () => {
+		try {
+			const { enabled, whatsNewEnabled, whatsNewEndpoint } = versionNotificationSettings.value;
+			if (enabled && whatsNewEnabled && whatsNewEndpoint) {
+				const rootStore = require_useRootStore.useRootStore();
+				const current = rootStore.versionCli;
+				const instanceId = rootStore.instanceId;
+				const section = await __n8n_rest_api_client_api_versions.getWhatsNewSection(whatsNewEndpoint, current, instanceId);
+				if (section.items?.length > 0) {
+					setWhatsNew(section);
+					if (shouldShowWhatsNewCallout()) {
+						whatsNewCallout.value = showMessage({
+							title: whatsNew.value.title,
+							message: whatsNew.value.calloutText,
+							duration: 0,
+							position: "bottom-left",
+							customClass: "clickable whats-new-notification",
+							onClick: () => {
+								const articleId = whatsNew.value.items[0]?.id ?? 0;
+								telemetry.track("User clicked on what's new notification", { article_id: articleId });
+								modalOpeners.value.openModalWithData({
+									name: __n8n_frontend_constants_versions.WHATS_NEW_MODAL_KEY,
+									data: { articleId }
+								});
+							}
+						});
+						dismissWhatsNewCallout();
+					}
+				}
+			}
+		} catch (e) {
+			console.error("Failed to fetch Whats New section:", e);
+		}
+	};
+	const initialize = (settings) => {
+		versionNotificationSettings.value = settings;
+	};
+	const checkForNewVersions = async () => {
+		if (!areNotificationsEnabled.value) return;
+		await Promise.all([fetchVersions(), fetchWhatsNew()]);
+		if (currentVersion.value && currentVersion.value.hasSecurityIssue && nextVersions.value.length) {
+			const fixVersion = currentVersion.value.securityIssueFixVersion;
+			let message = "Please update to latest version.";
+			if (fixVersion) message = `Please update to version ${fixVersion} or higher.`;
+			message = `${message} <a class="primary-color">More info</a>`;
+			showToast({
+				title: "Critical update available",
+				message,
+				onClick: () => {
+					modalOpeners.value.openModal(__n8n_frontend_constants_versions.VERSIONS_MODAL_KEY);
+				},
+				closeOnClick: true,
+				customClass: "clickable",
+				type: "warning",
+				duration: 0
+			});
+		}
+	};
+	return {
+		currentVersion,
+		latestVersion,
+		nextVersions,
+		hasVersionUpdates,
+		hasSignificantUpdates,
+		areNotificationsEnabled,
+		infoUrl,
+		fetchVersions,
+		setVersions,
+		initialize,
+		registerModalOpeners,
+		checkForNewVersions,
+		fetchWhatsNew,
+		whatsNew,
+		whatsNewArticles,
+		isWhatsNewArticleRead,
+		setWhatsNewArticleRead,
+		closeWhatsNewCallout,
+		shouldShowWhatsNewCallout,
+		dismissWhatsNewCallout
+	};
+});
+
+//#endregion
+Object.defineProperty(exports, 'SEMVER_REGEX', {
+  enumerable: true,
+  get: function () {
+    return SEMVER_REGEX;
+  }
+});
+Object.defineProperty(exports, 'useVersionsStore', {
+  enumerable: true,
+  get: function () {
+    return useVersionsStore;
+  }
+});
+//# sourceMappingURL=versions2.store.cjs.map

package/dist/versions2.store.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions2.store.cjs","names":["STORES","useSettingsStore","useUsersStore","LOCAL_STORAGE_READ_WHATS_NEW_ARTICLES","LOCAL_STORAGE_DISMISSED_WHATS_NEW_CALLOUT","useRootStore","versionsApi","WHATS_NEW_MODAL_KEY","VERSIONS_MODAL_KEY"],"sources":["../src/versions.store.ts"],"sourcesContent":["import type { IVersionNotificationSettings } from '@n8n/api-types';\nimport { useStorage } from '@n8n/composables/useStorage';\nimport { useTelemetry } from '@n8n/composables/useTelemetry';\nimport { useToast, type NotificationHandle } from '@n8n/composables/useToast';\nimport {\n\tLOCAL_STORAGE_DISMISSED_WHATS_NEW_CALLOUT,\n\tLOCAL_STORAGE_READ_WHATS_NEW_ARTICLES,\n\tVERSIONS_MODAL_KEY,\n\tWHATS_NEW_MODAL_KEY,\n} from '@n8n/frontend-constants/versions';\nimport * as versionsApi from '@n8n/rest-api-client/api/versions';\nimport type { Version, WhatsNewSection } from '@n8n/rest-api-client/api/versions';\nimport { jsonParse } from 'n8n-workflow';\nimport { defineStore } from 'pinia';\nimport { computed, ref } from 'vue';\n\nimport { STORES } from './constants';\nimport type { ModalOpeners } from './modalOpeners';\nimport { useSettingsStore } from './settings.store';\nimport { useRootStore } from './useRootStore';\nimport { useUsersStore } from './users.store';\n\ntype SetVersionParams = { versions: Version[]; currentVersion: string };\n\n/**\n * Semantic versioning 2.0.0, Regex from https://semver.org/\n * Capture groups: major, minor, patch, prerelease, buildmetadata\n */\nexport const SEMVER_REGEX =\n\t/^(?<major>0|[1-9]\\d*)\\.(?<minor>0|[1-9]\\d*)\\.(?<patch>0|[1-9]\\d*)(?:-(?<prerelease>(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+(?<buildmetadata>[0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$/;\n\nexport const useVersionsStore = defineStore(STORES.VERSIONS, () => {\n\tconst versionNotificationSettings = ref<IVersionNotificationSettings>({\n\t\tenabled: false,\n\t\twhatsNewEnabled: false,\n\t\tendpoint: '',\n\t\twhatsNewEndpoint: '',\n\t\tinfoUrl: '',\n\t});\n\tconst nextVersions = ref<Version[]>([]);\n\tconst currentVersion = ref<Version | undefined>();\n\tconst whatsNew = ref<WhatsNewSection>({\n\t\ttitle: '',\n\t\tcreatedAt: new Date().toISOString(),\n\t\tupdatedAt: null,\n\t\tcalloutText: '',\n\t\tfooter: '',\n\t\titems: [],\n\t});\n\tconst whatsNewCallout = ref<NotificationHandle | undefined>();\n\n\tconst telemetry = useTelemetry();\n\tconst { showToast, showMessage } = useToast();\n\tconst settingsStore = useSettingsStore();\n\tconst usersStore = useUsersStore();\n\n\t// Modal-open actions, registered at app bootstrap (see app/init.ts). Until then\n\t// they no-op — warning in dev — so the store never reaches into `ui.store`.\n\tconst warnModalOpenerMissing = (action: string) => {\n\t\tif (import.meta.env.DEV) {\n\t\t\tconsole.warn(\n\t\t\t\t`[versions.store] ${action} called before modal openers were registered; ignoring. Call registerModalOpeners() at app bootstrap.`,\n\t\t\t);\n\t\t}\n\t};\n\tconst modalOpeners = ref<ModalOpeners>({\n\t\topenModal: (name) => warnModalOpenerMissing(`openModal(${String(name)})`),\n\t\topenModalWithData: (payload) =>\n\t\t\twarnModalOpenerMissing(`openModalWithData(${String(payload.name)})`),\n\t});\n\tconst registerModalOpeners = (openers: ModalOpeners) => {\n\t\tmodalOpeners.value = openers;\n\t};\n\tconst readWhatsNewArticlesStorage = useStorage(LOCAL_STORAGE_READ_WHATS_NEW_ARTICLES);\n\tconst lastDismissedWhatsNewCalloutStorage = useStorage(LOCAL_STORAGE_DISMISSED_WHATS_NEW_CALLOUT);\n\n\t// ---------------------------------------------------------------------------\n\t// #region Computed\n\t// ---------------------------------------------------------------------------\n\n\tconst hasVersionUpdates = computed(() => {\n\t\treturn settingsStore.settings.releaseChannel === 'stable' && nextVersions.value.length > 0;\n\t});\n\n\tconst hasSignificantUpdates = computed(() => {\n\t\tif (!hasVersionUpdates.value || !currentVersion.value || !latestVersion.value) return false;\n\n\t\t// Always consider security issues as significant updates\n\t\tif (currentVersion.value.hasSecurityIssue) return true;\n\n\t\tconst current = currentVersion.value.name.match(SEMVER_REGEX);\n\t\tconst latest = latestVersion.value.name.match(SEMVER_REGEX);\n\n\t\tif (!current?.groups || !latest?.groups) return false;\n\n\t\t// Major change is always significant\n\t\tif (Number(current.groups.major) !== Number(latest.groups.major)) {\n\t\t\treturn true;\n\t\t}\n\n\t\tconst currentMinor = Number(current.groups.minor);\n\t\tconst latestMinor = Number(latest.groups.minor);\n\n\t\t// Otherwise two minor versions is enough to be considered significant\n\t\treturn latestMinor - currentMinor >= 2;\n\t});\n\n\tconst latestVersion = computed(() => {\n\t\treturn nextVersions.value[0] ?? currentVersion.value;\n\t});\n\n\tconst areNotificationsEnabled = computed(() => {\n\t\treturn versionNotificationSettings.value.enabled;\n\t});\n\n\tconst infoUrl = computed(() => {\n\t\treturn versionNotificationSettings.value.infoUrl;\n\t});\n\n\tconst readWhatsNewArticles = computed((): number[] => {\n\t\treturn readWhatsNewArticlesStorage.value\n\t\t\t? jsonParse(readWhatsNewArticlesStorage.value, { fallbackValue: [] })\n\t\t\t: [];\n\t});\n\n\tconst lastDismissedWhatsNewCallout = computed((): number[] => {\n\t\treturn lastDismissedWhatsNewCalloutStorage.value\n\t\t\t? jsonParse(lastDismissedWhatsNewCalloutStorage.value, { fallbackValue: [] })\n\t\t\t: [];\n\t});\n\n\tconst whatsNewArticles = computed(() => {\n\t\treturn whatsNew.value.items;\n\t});\n\n\t// #endregion\n\n\t// ---------------------------------------------------------------------------\n\t// #region Methods\n\t// ---------------------------------------------------------------------------\n\n\tconst fetchVersions = async () => {\n\t\ttry {\n\t\t\tconst { enabled, endpoint } = versionNotificationSettings.value;\n\t\t\tif (enabled && endpoint) {\n\t\t\t\tconst rootStore = useRootStore();\n\t\t\t\tconst current = rootStore.versionCli;\n\t\t\t\tconst instanceId = rootStore.instanceId;\n\t\t\t\tconst versions = await versionsApi.getNextVersions(endpoint, current, instanceId);\n\t\t\t\tsetVersions({ versions, currentVersion: current });\n\t\t\t}\n\t\t} catch (e) {\n\t\t\tconsole.error('Failed to fetch versions:', e);\n\t\t}\n\t};\n\n\tconst setVersions = (params: SetVersionParams) => {\n\t\tnextVersions.value = params.versions.filter((v) => v.name !== params.currentVersion);\n\t\tcurrentVersion.value = params.versions.find((v) => v.name === params.currentVersion);\n\t};\n\n\tconst setWhatsNew = (section: WhatsNewSection) => {\n\t\twhatsNew.value = section;\n\t};\n\n\tconst setWhatsNewArticleRead = (articleId: number) => {\n\t\tif (!readWhatsNewArticles.value.includes(articleId)) {\n\t\t\treadWhatsNewArticlesStorage.value = JSON.stringify([\n\t\t\t\t...readWhatsNewArticles.value,\n\t\t\t\tarticleId,\n\t\t\t]);\n\t\t}\n\t};\n\n\tconst isWhatsNewArticleRead = (articleId: number): boolean => {\n\t\treturn readWhatsNewArticles.value.includes(articleId);\n\t};\n\n\tconst closeWhatsNewCallout = () => {\n\t\twhatsNewCallout.value?.close();\n\t\twhatsNewCallout.value = undefined;\n\t};\n\n\tconst dismissWhatsNewCallout = () => {\n\t\tlastDismissedWhatsNewCalloutStorage.value = JSON.stringify(\n\t\t\twhatsNewArticles.value.map((item) => item.id),\n\t\t);\n\t};\n\n\tconst shouldShowWhatsNewCallout = (): boolean => {\n\t\tconst createdAt = usersStore.currentUser?.createdAt;\n\t\tlet hasNewArticle = false;\n\t\tif (createdAt) {\n\t\t\tconst userCreatedAt = new Date(createdAt).getTime();\n\t\t\thasNewArticle = whatsNewArticles.value.some((item) => {\n\t\t\t\tconst updatedAt = item.updatedAt ? new Date(item.updatedAt).getTime() : 0;\n\t\t\t\treturn updatedAt > userCreatedAt;\n\t\t\t});\n\t\t} else {\n\t\t\thasNewArticle = true;\n\t\t}\n\t\tconst allArticlesDismissed = whatsNewArticles.value.every((item) =>\n\t\t\tlastDismissedWhatsNewCallout.value.includes(item.id),\n\t\t);\n\n\t\treturn hasNewArticle && !allArticlesDismissed;\n\t};\n\n\tconst fetchWhatsNew = async () => {\n\t\ttry {\n\t\t\tconst { enabled, whatsNewEnabled, whatsNewEndpoint } = versionNotificationSettings.value;\n\t\t\tif (enabled && whatsNewEnabled && whatsNewEndpoint) {\n\t\t\t\tconst rootStore = useRootStore();\n\t\t\t\tconst current = rootStore.versionCli;\n\t\t\t\tconst instanceId = rootStore.instanceId;\n\t\t\t\tconst section = await versionsApi.getWhatsNewSection(whatsNewEndpoint, current, instanceId);\n\n\t\t\t\tif (section.items?.length > 0) {\n\t\t\t\t\tsetWhatsNew(section);\n\n\t\t\t\t\tif (shouldShowWhatsNewCallout()) {\n\t\t\t\t\t\twhatsNewCallout.value = showMessage({\n\t\t\t\t\t\t\ttitle: whatsNew.value.title,\n\t\t\t\t\t\t\tmessage: whatsNew.value.calloutText,\n\t\t\t\t\t\t\tduration: 0,\n\t\t\t\t\t\t\tposition: 'bottom-left',\n\t\t\t\t\t\t\tcustomClass: 'clickable whats-new-notification',\n\t\t\t\t\t\t\tonClick: () => {\n\t\t\t\t\t\t\t\tconst articleId = whatsNew.value.items[0]?.id ?? 0;\n\t\t\t\t\t\t\t\ttelemetry.track(\"User clicked on what's new notification\", {\n\t\t\t\t\t\t\t\t\tarticle_id: articleId,\n\t\t\t\t\t\t\t\t});\n\t\t\t\t\t\t\t\tmodalOpeners.value.openModalWithData({\n\t\t\t\t\t\t\t\t\tname: WHATS_NEW_MODAL_KEY,\n\t\t\t\t\t\t\t\t\tdata: { articleId },\n\t\t\t\t\t\t\t\t});\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t});\n\n\t\t\t\t\t\t// Mark the callout as dismissed as soon as it is shown, so it does not\n\t\t\t\t\t\t// keep reappearing on subsequent loads for users who simply ignore it.\n\t\t\t\t\t\tdismissWhatsNewCallout();\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t} catch (e) {\n\t\t\tconsole.error('Failed to fetch Whats New section:', e);\n\t\t}\n\t};\n\n\tconst initialize = (settings: IVersionNotificationSettings) => {\n\t\tversionNotificationSettings.value = settings;\n\t};\n\n\tconst checkForNewVersions = async () => {\n\t\tconst enabled = areNotificationsEnabled.value;\n\t\tif (!enabled) {\n\t\t\treturn;\n\t\t}\n\n\t\tawait Promise.all([fetchVersions(), fetchWhatsNew()]);\n\n\t\tif (\n\t\t\tcurrentVersion.value &&\n\t\t\tcurrentVersion.value.hasSecurityIssue &&\n\t\t\tnextVersions.value.length\n\t\t) {\n\t\t\tconst fixVersion = currentVersion.value.securityIssueFixVersion;\n\t\t\tlet message = 'Please update to latest version.';\n\t\t\tif (fixVersion) {\n\t\t\t\tmessage = `Please update to version ${fixVersion} or higher.`;\n\t\t\t}\n\n\t\t\tmessage = `${message} <a class=\"primary-color\">More info</a>`;\n\t\t\tshowToast({\n\t\t\t\ttitle: 'Critical update available',\n\t\t\t\tmessage,\n\t\t\t\tonClick: () => {\n\t\t\t\t\tmodalOpeners.value.openModal(VERSIONS_MODAL_KEY);\n\t\t\t\t},\n\t\t\t\tcloseOnClick: true,\n\t\t\t\tcustomClass: 'clickable',\n\t\t\t\ttype: 'warning',\n\t\t\t\tduration: 0,\n\t\t\t});\n\t\t}\n\t};\n\n\t// #endregion\n\n\treturn {\n\t\tcurrentVersion,\n\t\tlatestVersion,\n\t\tnextVersions,\n\t\thasVersionUpdates,\n\t\thasSignificantUpdates,\n\t\tareNotificationsEnabled,\n\t\tinfoUrl,\n\t\tfetchVersions,\n\t\tsetVersions,\n\t\tinitialize,\n\t\tregisterModalOpeners,\n\t\tcheckForNewVersions,\n\t\tfetchWhatsNew,\n\t\twhatsNew,\n\t\twhatsNewArticles,\n\t\tisWhatsNewArticleRead,\n\t\tsetWhatsNewArticleRead,\n\t\tcloseWhatsNewCallout,\n\t\tshouldShowWhatsNewCallout,\n\t\tdismissWhatsNewCallout,\n\t};\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;AA4BA,MAAa,eACZ;AAED,MAAa,0CAA+BA,yBAAO,gBAAgB;CAClE,MAAM,2CAAgE;EACrE,SAAS;EACT,iBAAiB;EACjB,UAAU;EACV,kBAAkB;EAClB,SAAS;EACT,CAAC;CACF,MAAM,4BAA8B,EAAE,CAAC;CACvC,MAAM,+BAA2C;CACjD,MAAM,wBAAgC;EACrC,OAAO;EACP,4BAAW,IAAI,MAAM,EAAC,aAAa;EACnC,WAAW;EACX,aAAa;EACb,QAAQ;EACR,OAAO,EAAE;EACT,CAAC;CACF,MAAM,gCAAuD;CAE7D,MAAM,8DAA0B;CAChC,MAAM,EAAE,WAAW,0DAA0B;CAC7C,MAAM,gBAAgBC,yCAAkB;CACxC,MAAM,aAAaC,mCAAe;CAIlC,MAAM,0BAA0B,WAAmB;AAClD,SAAgB,IAAI,IACnB,SAAQ,KACP,oBAAoB,OAAO,uGAC3B;;CAGH,MAAM,4BAAiC;EACtC,YAAY,SAAS,uBAAuB,aAAa,OAAO,KAAK,CAAC,GAAG;EACzE,oBAAoB,YACnB,uBAAuB,qBAAqB,OAAO,QAAQ,KAAK,CAAC,GAAG;EACrE,CAAC;CACF,MAAM,wBAAwB,YAA0B;AACvD,eAAa,QAAQ;;CAEtB,MAAM,2EAAyCC,wEAAsC;CACrF,MAAM,mFAAiDC,4EAA0C;CAMjG,MAAM,4CAAmC;AACxC,SAAO,cAAc,SAAS,mBAAmB,YAAY,aAAa,MAAM,SAAS;GACxF;CAEF,MAAM,gDAAuC;AAC5C,MAAI,CAAC,kBAAkB,SAAS,CAAC,eAAe,SAAS,CAAC,cAAc,MAAO,QAAO;AAGtF,MAAI,eAAe,MAAM,iBAAkB,QAAO;EAElD,MAAM,UAAU,eAAe,MAAM,KAAK,MAAM,aAAa;EAC7D,MAAM,SAAS,cAAc,MAAM,KAAK,MAAM,aAAa;AAE3D,MAAI,CAAC,SAAS,UAAU,CAAC,QAAQ,OAAQ,QAAO;AAGhD,MAAI,OAAO,QAAQ,OAAO,MAAM,KAAK,OAAO,OAAO,OAAO,MAAM,CAC/D,QAAO;EAGR,MAAM,eAAe,OAAO,QAAQ,OAAO,MAAM;AAIjD,SAHoB,OAAO,OAAO,OAAO,MAAM,GAG1B,gBAAgB;GACpC;CAEF,MAAM,wCAA+B;AACpC,SAAO,aAAa,MAAM,MAAM,eAAe;GAC9C;CAEF,MAAM,kDAAyC;AAC9C,SAAO,4BAA4B,MAAM;GACxC;CAEF,MAAM,kCAAyB;AAC9B,SAAO,4BAA4B,MAAM;GACxC;CAEF,MAAM,+CAAgD;AACrD,SAAO,4BAA4B,oCACtB,4BAA4B,OAAO,EAAE,eAAe,EAAE,EAAE,CAAC,GACnE,EAAE;GACJ;CAEF,MAAM,uDAAwD;AAC7D,SAAO,oCAAoC,oCAC9B,oCAAoC,OAAO,EAAE,eAAe,EAAE,EAAE,CAAC,GAC3E,EAAE;GACJ;CAEF,MAAM,2CAAkC;AACvC,SAAO,SAAS,MAAM;GACrB;CAQF,MAAM,gBAAgB,YAAY;AACjC,MAAI;GACH,MAAM,EAAE,SAAS,aAAa,4BAA4B;AAC1D,OAAI,WAAW,UAAU;IACxB,MAAM,YAAYC,mCAAc;IAChC,MAAM,UAAU,UAAU;IAC1B,MAAM,aAAa,UAAU;AAE7B,gBAAY;KAAE,UADG,MAAMC,mCAAY,gBAAgB,UAAU,SAAS,WAAW;KACzD,gBAAgB;KAAS,CAAC;;WAE3C,GAAG;AACX,WAAQ,MAAM,6BAA6B,EAAE;;;CAI/C,MAAM,eAAe,WAA6B;AACjD,eAAa,QAAQ,OAAO,SAAS,QAAQ,MAAM,EAAE,SAAS,OAAO,eAAe;AACpF,iBAAe,QAAQ,OAAO,SAAS,MAAM,MAAM,EAAE,SAAS,OAAO,eAAe;;CAGrF,MAAM,eAAe,YAA6B;AACjD,WAAS,QAAQ;;CAGlB,MAAM,0BAA0B,cAAsB;AACrD,MAAI,CAAC,qBAAqB,MAAM,SAAS,UAAU,CAClD,6BAA4B,QAAQ,KAAK,UAAU,CAClD,GAAG,qBAAqB,OACxB,UACA,CAAC;;CAIJ,MAAM,yBAAyB,cAA+B;AAC7D,SAAO,qBAAqB,MAAM,SAAS,UAAU;;CAGtD,MAAM,6BAA6B;AAClC,kBAAgB,OAAO,OAAO;AAC9B,kBAAgB,QAAQ;;CAGzB,MAAM,+BAA+B;AACpC,sCAAoC,QAAQ,KAAK,UAChD,iBAAiB,MAAM,KAAK,SAAS,KAAK,GAAG,CAC7C;;CAGF,MAAM,kCAA2C;EAChD,MAAM,YAAY,WAAW,aAAa;EAC1C,IAAI,gBAAgB;AACpB,MAAI,WAAW;GACd,MAAM,gBAAgB,IAAI,KAAK,UAAU,CAAC,SAAS;AACnD,mBAAgB,iBAAiB,MAAM,MAAM,SAAS;AAErD,YADkB,KAAK,YAAY,IAAI,KAAK,KAAK,UAAU,CAAC,SAAS,GAAG,KACrD;KAClB;QAEF,iBAAgB;EAEjB,MAAM,uBAAuB,iBAAiB,MAAM,OAAO,SAC1D,6BAA6B,MAAM,SAAS,KAAK,GAAG,CACpD;AAED,SAAO,iBAAiB,CAAC;;CAG1B,MAAM,gBAAgB,YAAY;AACjC,MAAI;GACH,MAAM,EAAE,SAAS,iBAAiB,qBAAqB,4BAA4B;AACnF,OAAI,WAAW,mBAAmB,kBAAkB;IACnD,MAAM,YAAYD,mCAAc;IAChC,MAAM,UAAU,UAAU;IAC1B,MAAM,aAAa,UAAU;IAC7B,MAAM,UAAU,MAAMC,mCAAY,mBAAmB,kBAAkB,SAAS,WAAW;AAE3F,QAAI,QAAQ,OAAO,SAAS,GAAG;AAC9B,iBAAY,QAAQ;AAEpB,SAAI,2BAA2B,EAAE;AAChC,sBAAgB,QAAQ,YAAY;OACnC,OAAO,SAAS,MAAM;OACtB,SAAS,SAAS,MAAM;OACxB,UAAU;OACV,UAAU;OACV,aAAa;OACb,eAAe;QACd,MAAM,YAAY,SAAS,MAAM,MAAM,IAAI,MAAM;AACjD,kBAAU,MAAM,2CAA2C,EAC1D,YAAY,WACZ,CAAC;AACF,qBAAa,MAAM,kBAAkB;SACpC,MAAMC;SACN,MAAM,EAAE,WAAW;SACnB,CAAC;;OAEH,CAAC;AAIF,8BAAwB;;;;WAInB,GAAG;AACX,WAAQ,MAAM,sCAAsC,EAAE;;;CAIxD,MAAM,cAAc,aAA2C;AAC9D,8BAA4B,QAAQ;;CAGrC,MAAM,sBAAsB,YAAY;AAEvC,MAAI,CADY,wBAAwB,MAEvC;AAGD,QAAM,QAAQ,IAAI,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;AAErD,MACC,eAAe,SACf,eAAe,MAAM,oBACrB,aAAa,MAAM,QAClB;GACD,MAAM,aAAa,eAAe,MAAM;GACxC,IAAI,UAAU;AACd,OAAI,WACH,WAAU,4BAA4B,WAAW;AAGlD,aAAU,GAAG,QAAQ;AACrB,aAAU;IACT,OAAO;IACP;IACA,eAAe;AACd,kBAAa,MAAM,UAAUC,qDAAmB;;IAEjD,cAAc;IACd,aAAa;IACb,MAAM;IACN,UAAU;IACV,CAAC;;;AAMJ,QAAO;EACN;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA"}