@kirby-tools/licensing 0.6.0 → 0.6.1

package/dist/constants.js

@@ -0,0 +1,62 @@
+//#region src/constants.ts
+const TRANSLATIONS = {
+	en: {
+		"modal.fields.info": "Thanks for purchasing {label}! Please enter your email address and order ID to activate your license.",
+		"modal.fields.orderId.help": "<a href=\"https://app.lemonsqueezy.com/my-orders\" target=\"_blank\">Find your order number</a> on Lemon Squeezy or <a href=\"mailto:hello@kirby.tools\">contact us</a> if you cannot find it.",
+		"errors.validation.missingFields": "Email address and order ID are required",
+		"errors.validation.invalidCredentials": "Email address or order ID is incorrect",
+		"errors.license.invalidPlugin": "License key invalid for this plugin",
+		"errors.license.versionMismatch": "License key invalid for this plugin version",
+		"errors.license.needsUpgrade": "License key invalid for this plugin version. Upgrade now on https://hub.kirby.tools.",
+		"errors.activation.alreadyUsed": "License key already activated",
+		"activate": "Activate",
+		"activated": "Plugin activated",
+		"buy": "Buy a license",
+		"upgrade": "Upgrade"
+	},
+	de: {
+		"modal.fields.info": "Dankeschön für den Kauf von {label}! Bitte gib deine E-Mail-Adresse und Bestellnummer ein, um deine Lizenz zu aktivieren.",
+		"modal.fields.orderId.help": "<a href=\"https://app.lemonsqueezy.com/my-orders\" target=\"_blank\">Finde deine Bestellnummer</a> bei Lemon Squeezy oder <a href=\"mailto:hello@kirby.tools\">kontaktiere uns</a>, wenn du sie nicht finden kannst.",
+		"errors.validation.missingFields": "E-Mail-Adresse und Bestellnummer sind notwendig",
+		"errors.validation.invalidCredentials": "E-Mail-Adresse oder Bestellnummer ist falsch",
+		"errors.license.invalidPlugin": "Lizenzschlüssel ungültig für dieses Plugin",
+		"errors.license.versionMismatch": "Lizenzschlüssel ungültig für diese Plugin-Version",
+		"errors.license.needsUpgrade": "Lizenzschlüssel ungültig für diese Plugin-Version. Aktualisiere jetzt auf https://hub.kirby.tools.",
+		"errors.activation.alreadyUsed": "Lizenzschlüssel bereits aktiviert",
+		"activate": "Aktivieren",
+		"activated": "Plugin aktiviert",
+		"buy": "Lizenz kaufen",
+		"upgrade": "Upgrade"
+	},
+	fr: {
+		"modal.fields.info": "Merci d'avoir acheté {label} ! Veuillez saisir votre adresse e-mail et votre numéro de commande pour activer votre licence.",
+		"modal.fields.orderId.help": "<a href=\"https://app.lemonsqueezy.com/my-orders\" target=\"_blank\">Trouvez votre numéro de commande</a> sur Lemon Squeezy ou <a href=\"mailto:hello@kirby.tools\">contactez-nous</a> si vous ne le trouvez pas.",
+		"errors.validation.missingFields": "Adresse e-mail et numéro de commande requis",
+		"errors.validation.invalidCredentials": "Adresse e-mail ou numéro de commande incorrect",
+		"errors.license.invalidPlugin": "Clé de licence invalide pour ce plugin",
+		"errors.license.versionMismatch": "Clé de licence invalide pour cette version du plugin",
+		"errors.license.needsUpgrade": "Clé de licence invalide pour cette version du plugin. Mettez à niveau maintenant sur https://hub.kirby.tools.",
+		"errors.activation.alreadyUsed": "Clé de licence déjà activée",
+		"activate": "Activer",
+		"activated": "Plugin activé",
+		"buy": "Acheter une licence",
+		"upgrade": "Upgrade"
+	},
+	nl: {
+		"modal.fields.info": "Bedankt voor het kopen van {label}! Voer je e-mailadres en bestelnummer in om je licentie te activeren.",
+		"modal.fields.orderId.help": "<a href=\"https://app.lemonsqueezy.com/my-orders\" target=\"_blank\">Vind je bestelnummer</a> op Lemon Squeezy of <a href=\"mailto:hello@kirby.tools\">neem contact met ons op</a> als je het niet kunt vinden.",
+		"errors.validation.missingFields": "E-mailadres en bestelnummer zijn verplicht",
+		"errors.validation.invalidCredentials": "E-mailadres of bestelnummer is onjuist",
+		"errors.license.invalidPlugin": "Licentiesleutel ongeldig voor dit plug-in",
+		"errors.license.versionMismatch": "Licentiesleutel ongeldig voor deze plug-inversie",
+		"errors.license.needsUpgrade": "Licentiesleutel ongeldig voor deze plug-inversie. Upgrade nu op https://hub.kirby.tools.",
+		"errors.activation.alreadyUsed": "Licentiesleutel al geactiveerd",
+		"activate": "Activeren",
+		"activated": "Plugin geactiveerd",
+		"buy": "Koop een licentie",
+		"upgrade": "Upgrade"
+	}
+};
+
+//#endregion
+export { TRANSLATIONS };

package/dist/index.d.ts

@@ -1,38 +1,4 @@
-import { ComponentPublicInstance, Ref } from "vue";
-
-//#region src/types.d.ts
-type MaybeRef<T = any> = T | Ref<T>;
-type LicenseKey = string;
-type LicenseStatus = 'active' | 'inactive' | 'invalid' | 'incompatible' | 'upgradeable';
-interface License {
-  key: LicenseKey;
-  version: number;
-  compatibility: string;
-}
-//#endregion
-//#region src/license.d.ts
-interface LicenseOptions {
-  label: string;
-  apiNamespace: string;
-}
-interface LicenseModalResult {
-  isLicenseActive: boolean;
-}
-declare function useLicense(licenseOptions: LicenseOptions): {
-  isLocalhost: boolean;
-  assertActivationIntegrity: ({
-    component,
-    licenseStatus
-  }: {
-    component: MaybeRef<ComponentPublicInstance | null | undefined>;
-    licenseStatus: MaybeRef<LicenseStatus>;
-  }) => void;
-  openLicenseModal: () => Promise<{
-    isLicenseActive: boolean;
-  }>;
-};
-//#endregion
-//#region src/utils.d.ts
-declare function isLocal(): boolean;
-//#endregion
+import { License, LicenseKey, LicenseStatus } from "./types.js";
+import { LicenseModalResult, LicenseOptions, useLicense } from "./license.js";
+import { isLocal } from "./utils.js";
 export { type License, type LicenseKey, LicenseModalResult, LicenseOptions, type LicenseStatus, isLocal, useLicense };

package/dist/index.js

@@ -1,171 +1,4 @@
-import { unref, useDialog, usePanel } from "kirbyuse";
+import { isLocal } from "./utils.js";
+import { useLicense } from "./license.js";
 
-//#region src/constants.ts
-const TRANSLATIONS = {
-	en: {
-		"modal.fields.info": "Thanks for purchasing {label}! Please enter your email address and order ID to activate your license.",
-		"modal.fields.orderId.help": "<a href=\"https://app.lemonsqueezy.com/my-orders\" target=\"_blank\">Find your order number</a> on Lemon Squeezy or <a href=\"mailto:hello@kirby.tools\">contact us</a> if you cannot find it.",
-		"errors.validation.missingFields": "Email address and order ID are required",
-		"errors.validation.invalidCredentials": "Email address or order ID is incorrect",
-		"errors.license.invalidPlugin": "License key invalid for this plugin",
-		"errors.license.versionMismatch": "License key invalid for this plugin version",
-		"errors.license.needsUpgrade": "License key invalid for this plugin version. Upgrade now on https://hub.kirby.tools.",
-		"errors.activation.alreadyUsed": "License key already activated",
-		"activate": "Activate",
-		"activated": "Plugin activated",
-		"buy": "Buy a license",
-		"upgrade": "Upgrade"
-	},
-	de: {
-		"modal.fields.info": "Dankeschön für den Kauf von {label}! Bitte gib deine E-Mail-Adresse und Bestellnummer ein, um deine Lizenz zu aktivieren.",
-		"modal.fields.orderId.help": "<a href=\"https://app.lemonsqueezy.com/my-orders\" target=\"_blank\">Finde deine Bestellnummer</a> bei Lemon Squeezy oder <a href=\"mailto:hello@kirby.tools\">kontaktiere uns</a>, wenn du sie nicht finden kannst.",
-		"errors.validation.missingFields": "E-Mail-Adresse und Bestellnummer sind notwendig",
-		"errors.validation.invalidCredentials": "E-Mail-Adresse oder Bestellnummer ist falsch",
-		"errors.license.invalidPlugin": "Lizenzschlüssel ungültig für dieses Plugin",
-		"errors.license.versionMismatch": "Lizenzschlüssel ungültig für diese Plugin-Version",
-		"errors.license.needsUpgrade": "Lizenzschlüssel ungültig für diese Plugin-Version. Aktualisiere jetzt auf https://hub.kirby.tools.",
-		"errors.activation.alreadyUsed": "Lizenzschlüssel bereits aktiviert",
-		"activate": "Aktivieren",
-		"activated": "Plugin aktiviert",
-		"buy": "Lizenz kaufen",
-		"upgrade": "Upgrade"
-	},
-	fr: {
-		"modal.fields.info": "Merci d'avoir acheté {label} ! Veuillez saisir votre adresse e-mail et votre numéro de commande pour activer votre licence.",
-		"modal.fields.orderId.help": "<a href=\"https://app.lemonsqueezy.com/my-orders\" target=\"_blank\">Trouvez votre numéro de commande</a> sur Lemon Squeezy ou <a href=\"mailto:hello@kirby.tools\">contactez-nous</a> si vous ne le trouvez pas.",
-		"errors.validation.missingFields": "Adresse e-mail et numéro de commande requis",
-		"errors.validation.invalidCredentials": "Adresse e-mail ou numéro de commande incorrect",
-		"errors.license.invalidPlugin": "Clé de licence invalide pour ce plugin",
-		"errors.license.versionMismatch": "Clé de licence invalide pour cette version du plugin",
-		"errors.license.needsUpgrade": "Clé de licence invalide pour cette version du plugin. Mettez à niveau maintenant sur https://hub.kirby.tools.",
-		"errors.activation.alreadyUsed": "Clé de licence déjà activée",
-		"activate": "Activer",
-		"activated": "Plugin activé",
-		"buy": "Acheter une licence",
-		"upgrade": "Upgrade"
-	},
-	nl: {
-		"modal.fields.info": "Bedankt voor het kopen van {label}! Voer je e-mailadres en bestelnummer in om je licentie te activeren.",
-		"modal.fields.orderId.help": "<a href=\"https://app.lemonsqueezy.com/my-orders\" target=\"_blank\">Vind je bestelnummer</a> op Lemon Squeezy of <a href=\"mailto:hello@kirby.tools\">neem contact met ons op</a> als je het niet kunt vinden.",
-		"errors.validation.missingFields": "E-mailadres en bestelnummer zijn verplicht",
-		"errors.validation.invalidCredentials": "E-mailadres of bestelnummer is onjuist",
-		"errors.license.invalidPlugin": "Licentiesleutel ongeldig voor dit plug-in",
-		"errors.license.versionMismatch": "Licentiesleutel ongeldig voor deze plug-inversie",
-		"errors.license.needsUpgrade": "Licentiesleutel ongeldig voor deze plug-inversie. Upgrade nu op https://hub.kirby.tools.",
-		"errors.activation.alreadyUsed": "Licentiesleutel al geactiveerd",
-		"activate": "Activeren",
-		"activated": "Plugin geactiveerd",
-		"buy": "Koop een licentie",
-		"upgrade": "Upgrade"
-	}
-};
-
-//#endregion
-//#region src/utils.ts
-const LOCALHOST_HOSTNAMES = [
-	"localhost",
-	"127.0.0.1",
-	"[::1]"
-];
-const LOCAL_DOMAINS = [
-	"local",
-	"test",
-	"ddev.site"
-];
-function t(key = "", data) {
-	const languageCode = window.panel.translation.code;
-	const translation = TRANSLATIONS?.[languageCode]?.[key] ?? key;
-	return data ? template(translation, data) : translation;
-}
-function template(input, values, fallback) {
-	return input.replace(/\{(\w+)\}/g, (_, key) => values[key] || ((typeof fallback === "function" ? fallback(key) : fallback) ?? key));
-}
-function isLocal() {
-	const { hostname } = window.location;
-	const isLocalhost = LOCALHOST_HOSTNAMES.includes(hostname);
-	const isLocalDomain = LOCAL_DOMAINS.some((domain) => hostname.endsWith(`.${domain}`));
-	return isLocalhost || isLocalDomain;
-}
-
-//#endregion
-//#region src/license.ts
-const ERROR_MESSAGE_TRANSLATIONS = {
-	"Unauthorized": "errors.validation.invalidCredentials",
-	"License key not valid for this plugin": "errors.license.invalidPlugin",
-	"License key not valid for this plugin version": "errors.license.versionMismatch",
-	"License key not valid for this plugin version, please upgrade your license": "errors.license.needsUpgrade",
-	"License key already activated": "errors.activation.alreadyUsed"
-};
-const INTEGRITY_ERROR = "The activation buttons appear to be hidden. Please purchase a license.";
-function useLicense(licenseOptions) {
-	const panel = usePanel();
-	const { openFieldsDialog } = useDialog();
-	const isLocalhost = isLocal();
-	const openLicenseModal = async () => {
-		const { label } = licenseOptions;
-		return { isLicenseActive: (await openFieldsDialog({
-			submitButton: {
-				icon: "check",
-				theme: "love",
-				text: t("activate", { label })
-			},
-			fields: {
-				info: {
-					type: "info",
-					text: t("modal.fields.info", { label })
-				},
-				email: {
-					label: panel.t("email"),
-					type: "email"
-				},
-				orderId: {
-					label: "Order ID",
-					type: "text",
-					help: t("modal.fields.orderId.help", { label })
-				}
-			},
-			onSubmit: async (value) => {
-				const isLicenseActive = await activateLicense(value, licenseOptions);
-				if (!isLicenseActive) return false;
-				panel.notification.success(t("activated"));
-				return { isLicenseActive };
-			}
-		}))?.isLicenseActive ?? false };
-	};
-	const assertActivationIntegrity = ({ component, licenseStatus }) => {
-		if (unref(licenseStatus) === "active") return;
-		const element = unref(component)?.$el;
-		if (!element) throw new Error(INTEGRITY_ERROR);
-		const style = window.getComputedStyle(element);
-		if (style.display === "none" || style.visibility === "hidden" || style.opacity === "0" || style.clipPath === "inset(100%)" || style.transform.includes("scale(0")) throw new Error(INTEGRITY_ERROR);
-		const rect = element.getBoundingClientRect();
-		if (rect.width === 0 || rect.height === 0 || rect.right < 0 || rect.bottom < 0 || rect.left > window.innerWidth || rect.top > window.innerHeight) throw new Error(INTEGRITY_ERROR);
-	};
-	return {
-		isLocalhost,
-		assertActivationIntegrity,
-		openLicenseModal
-	};
-}
-async function activateLicense(event, licenseOptions) {
-	const panel = usePanel();
-	const { email, orderId } = event;
-	if (!email || !orderId) {
-		panel.notification.error(t("errors.validation.missingFields"));
-		return false;
-	}
-	try {
-		if ((await panel.api.post(`${licenseOptions.apiNamespace}/activate`, {
-			email,
-			orderId: Number(orderId)
-		}))?.status !== "ok") throw new Error("Failed to activate license key");
-		return true;
-	} catch (error) {
-		const message = error.message;
-		panel.notification.error(ERROR_MESSAGE_TRANSLATIONS[message] ? t(ERROR_MESSAGE_TRANSLATIONS[message]) : message);
-		return false;
-	}
-}
-
-//#endregion
 export { isLocal, useLicense };

package/dist/license.d.ts

@@ -0,0 +1,26 @@
+import { LicenseStatus, MaybeRef } from "./types.js";
+import { ComponentPublicInstance } from "vue";
+
+//#region src/license.d.ts
+interface LicenseOptions {
+  label: string;
+  apiNamespace: string;
+}
+interface LicenseModalResult {
+  isLicenseActive: boolean;
+}
+declare function useLicense(licenseOptions: LicenseOptions): {
+  isLocalhost: boolean;
+  assertActivationIntegrity: ({
+    component,
+    licenseStatus
+  }: {
+    component: MaybeRef<ComponentPublicInstance | null | undefined>;
+    licenseStatus: MaybeRef<LicenseStatus>;
+  }) => void;
+  openLicenseModal: () => Promise<{
+    isLicenseActive: boolean;
+  }>;
+};
+//#endregion
+export { LicenseModalResult, LicenseOptions, useLicense };

package/dist/license.js

@@ -0,0 +1,84 @@
+import { isLocal, t } from "./utils.js";
+import { unref, useDialog, usePanel } from "kirbyuse";
+
+//#region src/license.ts
+const ERROR_MESSAGE_TRANSLATIONS = {
+	"Unauthorized": "errors.validation.invalidCredentials",
+	"License key not valid for this plugin": "errors.license.invalidPlugin",
+	"License key not valid for this plugin version": "errors.license.versionMismatch",
+	"License key not valid for this plugin version, please upgrade your license": "errors.license.needsUpgrade",
+	"License key already activated": "errors.activation.alreadyUsed"
+};
+const INTEGRITY_ERROR = "The activation buttons appear to be hidden. Please purchase a license.";
+function useLicense(licenseOptions) {
+	const panel = usePanel();
+	const { openFieldsDialog } = useDialog();
+	const isLocalhost = isLocal();
+	const openLicenseModal = async () => {
+		const { label } = licenseOptions;
+		return { isLicenseActive: (await openFieldsDialog({
+			submitButton: {
+				icon: "check",
+				theme: "love",
+				text: t("activate", { label })
+			},
+			fields: {
+				info: {
+					type: "info",
+					text: t("modal.fields.info", { label })
+				},
+				email: {
+					label: panel.t("email"),
+					type: "email"
+				},
+				orderId: {
+					label: "Order ID",
+					type: "text",
+					help: t("modal.fields.orderId.help", { label })
+				}
+			},
+			onSubmit: async (value) => {
+				const isLicenseActive = await activateLicense(value, licenseOptions);
+				if (!isLicenseActive) return false;
+				panel.notification.success(t("activated"));
+				return { isLicenseActive };
+			}
+		}))?.isLicenseActive ?? false };
+	};
+	const assertActivationIntegrity = ({ component, licenseStatus }) => {
+		if (unref(licenseStatus) === "active") return;
+		const element = unref(component)?.$el;
+		if (!element) throw new Error(INTEGRITY_ERROR);
+		const style = window.getComputedStyle(element);
+		if (style.display === "none" || style.visibility === "hidden" || style.opacity === "0" || style.clipPath === "inset(100%)" || style.transform.includes("scale(0")) throw new Error(INTEGRITY_ERROR);
+		const rect = element.getBoundingClientRect();
+		if (rect.width === 0 || rect.height === 0 || rect.right < 0 || rect.bottom < 0 || rect.left > window.innerWidth || rect.top > window.innerHeight) throw new Error(INTEGRITY_ERROR);
+	};
+	return {
+		isLocalhost,
+		assertActivationIntegrity,
+		openLicenseModal
+	};
+}
+async function activateLicense(event, licenseOptions) {
+	const panel = usePanel();
+	const { email, orderId } = event;
+	if (!email || !orderId) {
+		panel.notification.error(t("errors.validation.missingFields"));
+		return false;
+	}
+	try {
+		if ((await panel.api.post(`${licenseOptions.apiNamespace}/activate`, {
+			email,
+			orderId: Number(orderId)
+		}))?.status !== "ok") throw new Error("Failed to activate license key");
+		return true;
+	} catch (error) {
+		const message = error.message;
+		panel.notification.error(ERROR_MESSAGE_TRANSLATIONS[message] ? t(ERROR_MESSAGE_TRANSLATIONS[message]) : message);
+		return false;
+	}
+}
+
+//#endregion
+export { useLicense };

package/dist/types.d.ts

@@ -0,0 +1,13 @@
+import { Ref } from "vue";
+
+//#region src/types.d.ts
+type MaybeRef<T = any> = T | Ref<T>;
+type LicenseKey = string;
+type LicenseStatus = 'active' | 'inactive' | 'invalid' | 'incompatible' | 'upgradeable';
+interface License {
+  key: LicenseKey;
+  version: number;
+  compatibility: string;
+}
+//#endregion
+export { License, LicenseKey, LicenseStatus, MaybeRef };

package/dist/utils.d.ts

@@ -0,0 +1,5 @@
+//#region src/utils.d.ts
+
+declare function isLocal(): boolean;
+//#endregion
+export { isLocal };

package/dist/utils.js

@@ -0,0 +1,30 @@
+import { TRANSLATIONS } from "./constants.js";
+
+//#region src/utils.ts
+const LOCALHOST_HOSTNAMES = [
+	"localhost",
+	"127.0.0.1",
+	"[::1]"
+];
+const LOCAL_DOMAINS = [
+	"local",
+	"test",
+	"ddev.site"
+];
+function template(input, values, fallback) {
+	return input.replace(/\{(\w+)\}/g, (_, key) => values[key] || ((typeof fallback === "function" ? fallback(key) : fallback) ?? key));
+}
+function t(key = "", data) {
+	const languageCode = window.panel.translation.code;
+	const translation = TRANSLATIONS?.[languageCode]?.[key] ?? key;
+	return data ? template(translation, data) : translation;
+}
+function isLocal() {
+	const { hostname } = window.location;
+	const isLocalhost = LOCALHOST_HOSTNAMES.includes(hostname);
+	const isLocalDomain = LOCAL_DOMAINS.some((domain) => hostname.endsWith(`.${domain}`));
+	return isLocalhost || isLocalDomain;
+}
+
+//#endregion
+export { isLocal, t };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kirby-tools/licensing",
   "type": "module",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "packageManager": "pnpm@10.28.0",
   "description": "License system for Kirby Tools plugins within the Kirby Panel",
   "author": "Johann Schopplich <hello@johannschopplich.com>",