@kirby-tools/licensing 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-PRESENT Johann Schopplich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# @kirby-tools/licensing
+
+Shared tooling for licensing Kirby Tools plugins from within the Kirby Panel.
+
+## License
+
+[MIT](./LICENSE) License © 2024-PRESENT [Johann Schopplich](https://github.com/johannschopplich)

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@kirby-tools/licensing",
+  "type": "module",
+  "version": "0.1.1",
+  "packageManager": "pnpm@9.3.0",
+  "description": "Shared tooling for licensing in the Panel",
+  "author": "Johann Schopplich <hello@johannschopplich.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/kirby-tools/licensing#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kirby-tools/licensing.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kirby-tools/licensing/issues"
+  },
+  "sideEffects": false,
+  "exports": {
+    ".": "./src/index.mjs"
+  },
+  "files": [
+    "src"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "release": "bumpp"
+  },
+  "dependencies": {
+    "kirbyuse": "^0.4.1"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^2.21.1",
+    "bumpp": "^9.4.1",
+    "eslint": "^9.5.0"
+  }
+}

package/src/constants.mjs

@@ -0,0 +1,20 @@
+export const TRANSLATIONS = {
+  en: {
+    'modal.info': 'Thanks for purchasing {plugin}! Please enter your email address and order ID to activate your license.',
+    'modal.help.orderId': '<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.',
+    'activate': 'Activate',
+    'activated': 'Plugin activated',
+  },
+  de: {
+    'modal.info': 'Dankeschön für den Kauf vom {plugin}! Bitte gib deine E-Mail-Adresse und Bestellnummer ein, um deine Lizenz zu aktivieren.',
+    'modal.help.orderId': '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.',
+    'activate': 'Aktivieren',
+    'activated': 'Plugin aktiviert',
+  },
+  fr: {
+    'modal.info': 'Merci d\'avoir acheté {plugin} ! Veuillez saisir votre adresse e-mail et votre numéro de commande pour activer votre licence.',
+    'modal.help.orderId': 'Obtenez votre numéro 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.',
+    'activate': 'Activer',
+    'activated': 'Plugin activé',
+  },
+}

package/src/index.mjs

@@ -0,0 +1 @@
+export { useLicense } from './license.mjs'

package/src/license.mjs

@@ -0,0 +1,92 @@
+import { useApi, usePanel } from 'kirbyuse'
+import { t } from './utils.mjs'
+
+/**
+ * @param {object} options
+ * @param {string} options.label
+ * @param {string} options.apiNamespace
+ * @returns {object}
+ */
+export function useLicense({
+  label,
+  apiNamespace,
+}) {
+  const panel = usePanel()
+  const api = useApi()
+  const isLocalhost = _isLocalhost()
+
+  const register = async (email, orderId) => {
+    if (!email || !orderId) {
+      throw new Error('Email and order ID are required')
+    }
+
+    const response = await api.post(`${apiNamespace}/register`, { email, orderId })
+    if (!response?.ok) {
+      throw new Error('Registration failed')
+    }
+
+    return true
+  }
+
+  const openLicenseModal = () => {
+    panel.dialog.open({
+      component: 'k-form-dialog',
+      props: {
+        submitButton: {
+          icon: 'check',
+          theme: 'love',
+          text: t('activate', { plugin: label }),
+        },
+        fields: {
+          info: {
+            type: 'info',
+            text: t('modal.info', { plugin: label }),
+          },
+          email: {
+            label: panel.t('email'),
+            type: 'email',
+          },
+          orderId: {
+            label: 'Order ID',
+            type: 'text',
+            help: t('modal.help.orderId', { plugin: label }),
+          },
+        },
+      },
+      on: {
+        submit: async (event) => {
+          const { email, orderId } = event
+          if (!email || !orderId) {
+            panel.notification.error('Email and order ID are required')
+            return
+          }
+
+          try {
+            await register(email, Number(orderId))
+          }
+          catch (error) {
+            panel.notification.error(error.message)
+            return
+          }
+
+          panel.dialog.close()
+          await panel.view.reload()
+          panel.notification.success(t('activated'), { plugin: label })
+        },
+      },
+    })
+  }
+
+  return {
+    isLocalhost,
+    openLicenseModal,
+  }
+}
+
+function _isLocalhost() {
+  const { hostname } = window.location
+  const isLocalhost = ['localhost', '127.0.0.1', '::1'].includes(hostname)
+  const isTestDomain = hostname.endsWith('.test')
+
+  return isLocalhost || isTestDomain
+}

package/src/utils.mjs

@@ -0,0 +1,19 @@
+import { usePanel } from 'kirbyuse'
+import { TRANSLATIONS } from './constants.mjs'
+
+export function t(key, data, fallback) {
+  const panel = usePanel()
+  const languageCode = panel.translation.code
+  const translation = TRANSLATIONS?.[languageCode]?.[key] ?? fallback
+  if (!translation)
+    return
+
+  return data ? template(translation, data) : translation
+}
+
+export function template(input, values, fallback) {
+  return input.replace(
+    /\{(\w+)\}/g,
+    (_, key) => values[key] || ((typeof fallback === 'function' ? fallback(key) : fallback) ?? key),
+  )
+}