@kirby-tools/licensing 0.2.2 → 0.3.1

package/dist/index.d.mts

@@ -2,9 +2,11 @@ import { Ref, ComponentPublicInstance } from 'vue';
 
 type MaybeRef<T = any> = T | Ref<T>;
 type LicenseKey = string;
+type LicenseStatus = 'active' | 'inactive' | 'invalid' | 'incompatible';
 interface License {
-    licenseKey: LicenseKey;
-    [key: string]: string;
+    key: LicenseKey;
+    version: number;
+    compatibility: string;
 }
 
 interface LicenseOptions {
@@ -16,9 +18,9 @@ interface LicenseModalResult {
 }
 declare function useLicense({ label, apiNamespace, }: LicenseOptions): {
     isLocalhost: boolean;
-    assertActivationIntegrity: ({ component, license }: {
+    assertActivationIntegrity: ({ component, licenseStatus }: {
         component: MaybeRef<ComponentPublicInstance | null | undefined>;
-        license: MaybeRef<boolean | string | License>;
+        licenseStatus: MaybeRef<LicenseStatus>;
     }) => Promise<void>;
     openLicenseModal: () => Promise<LicenseModalResult>;
 };

package/dist/index.d.ts

@@ -2,9 +2,11 @@ import { Ref, ComponentPublicInstance } from 'vue';
 
 type MaybeRef<T = any> = T | Ref<T>;
 type LicenseKey = string;
+type LicenseStatus = 'active' | 'inactive' | 'invalid' | 'incompatible';
 interface License {
-    licenseKey: LicenseKey;
-    [key: string]: string;
+    key: LicenseKey;
+    version: number;
+    compatibility: string;
 }
 
 interface LicenseOptions {
@@ -16,9 +18,9 @@ interface LicenseModalResult {
 }
 declare function useLicense({ label, apiNamespace, }: LicenseOptions): {
     isLocalhost: boolean;
-    assertActivationIntegrity: ({ component, license }: {
+    assertActivationIntegrity: ({ component, licenseStatus }: {
         component: MaybeRef<ComponentPublicInstance | null | undefined>;
-        license: MaybeRef<boolean | string | License>;
+        licenseStatus: MaybeRef<LicenseStatus>;
     }) => Promise<void>;
     openLicenseModal: () => Promise<LicenseModalResult>;
 };

package/dist/index.mjs

@@ -5,7 +5,9 @@ const TRANSLATIONS = {
     "modal.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">Get your order number</a> from Lemon Squeezy or <a href="mailto:hello@kirby.tools">contact us</a> if you cannot find it.',
     "modal.error.required.fields": "Email address and order ID are required",
+    "modal.error.invalid.unauthorized": "Email address or order ID is incorrect",
     "modal.error.invalid.licenseKey": "License key invalid for this plugin",
+    "modal.error.incompatible.licenseKey": "License key invalid for this plugin version",
     "modal.error.registered": "License key already registered",
     "activate": "Activate",
     "activated": "Plugin activated"
@@ -14,7 +16,9 @@ const TRANSLATIONS = {
     "modal.info": "Dankesch\xF6n f\xFCr den Kauf von {label}! Bitte gib deine E-Mail-Adresse und Bestellnummer ein, um deine Lizenz zu aktivieren.",
     "modal.fields.orderId.help": 'Rufe die <a href="https://app.lemonsqueezy.com/my-orders" target="_blank">Bestellnummer von Lemon Squeezy ab</a> oder <a href="mailto:hello@kirby.tools">kontaktiere uns</a>, wenn du sie nicht finden kannst.',
     "modal.error.required.fields": "E-Mail-Adresse und Bestellnummer sind notwendig",
+    "modal.error.invalid.unauthorized": "E-Mail-Adresse oder Bestellnummer ist falsch",
     "modal.error.invalid.licenseKey": "Lizenzschl\xFCssel ung\xFCltig f\xFCr dieses Plugin",
+    "modal.error.incompatible.licenseKey": "Lizenzschl\xFCssel ung\xFCltig f\xFCr diese Plugin-Version",
     "modal.error.registered": "Lizenzschl\xFCssel bereits registriert",
     "activate": "Aktivieren",
     "activated": "Plugin aktiviert"
@@ -23,7 +27,9 @@ const TRANSLATIONS = {
     "modal.info": "Merci d'avoir achet\xE9 {label} ! Veuillez saisir votre adresse e-mail et votre num\xE9ro de commande pour activer votre licence.",
     "modal.fields.orderId.help": 'Obtenez votre num\xE9ro de commande sur <a href="https://app.lemonsqueezy.com/my-orders" target="_blank">Lemon Squeezy</a> ou <a href="mailto:hello@kirby.tools">contactez-nous</a> si vous ne le trouvez pas.',
     "modal.error.required.fields": "Adresse e-mail et num\xE9ro de commande requis",
+    "modal.error.invalid.unauthorized": "Adresse e-mail ou num\xE9ro de commande incorrect",
     "modal.error.invalid.licenseKey": "Cl\xE9 de licence invalide pour ce plugin",
+    "modal.error.incompatible.licenseKey": "Cl\xE9 de licence invalide pour cette version du plugin",
     "modal.error.registered": "Cl\xE9 de licence d\xE9j\xE0 enregistr\xE9e",
     "activate": "Activer",
     "activated": "Plugin activ\xE9"
@@ -106,8 +112,12 @@ function useLicense({
               await register(email, Number(orderId));
             } catch (error) {
               let message = error.message;
-              if (message === "License key not valid for this plugin") {
+              if (message === "Unauthorized") {
+                message = t("modal.error.invalid.unauthorized");
+              } else if (message === "License key not valid for this plugin") {
                 message = t("modal.error.invalid.licenseKey");
+              } else if (message === "License key not valid for this plugin version") {
+                message = t("modal.error.incompatible.licenseKey");
               } else if (message === "License key already registered") {
                 message = t("modal.error.registered");
               }
@@ -122,14 +132,13 @@ function useLicense({
       });
     });
   };
-  const assertActivationIntegrity = async ({ component, license }) => {
-    const _component = unref(component);
-    const _license = unref(license);
-    if (_license !== false) {
+  const assertActivationIntegrity = async ({ component, licenseStatus }) => {
+    if (unref(licenseStatus) === "active") {
       return;
     }
     await nextTick();
-    if (!_component?.$el || window.getComputedStyle(_component.$el).display === "none" || window.getComputedStyle(_component.$el).visibility === "hidden") {
+    const _component = unref(component);
+    if (!_component?.$el || window.getComputedStyle(_component.$el).display === "none" || window.getComputedStyle(_component.$el).visibility === "hidden" || window.getComputedStyle(_component.$el).opacity === "0") {
       throw new Error("Are you trying to hide the activation buttons? Please buy a license.");
     }
   };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kirby-tools/licensing",
   "type": "module",
-  "version": "0.2.2",
+  "version": "0.3.1",
   "packageManager": "pnpm@9.4.0",
   "description": "Shared tooling for licensing in the Panel",
   "author": "Johann Schopplich <hello@johannschopplich.com>",