@attributech/nuxt-drupal-utils 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025
+
+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,104 @@
+# @attributech/nuxt-drupal-utils
+
+Shared utilities for Nuxt projects with Drupal backend.
+
+## Installation
+
+```bash
+npm install @attributech/nuxt-drupal-utils
+```
+
+## Features
+
+This package provides utility functions for handling URLs in Nuxt projects with Drupal backends, particularly for projects using Lagoon hosting:
+
+- `getApiUrl`: Determines the API endpoint URL
+- `getAppUrl`: Determines the application URL
+- `getServerUrl`: Determines the server URL
+- `getLagoonDevelopmentDomain`: Builds a Lagoon domain for development environments
+
+## Usage
+
+### Direct Import
+
+You can import the utilities directly:
+
+```js
+import { getApiUrl, getServerUrl, getAppUrl } from '@attributech/nuxt-drupal-utils'
+
+const serverUrl = getServerUrl('https://default-backend.com')
+const apiUrl = getApiUrl('https://default-backend.com')
+const appUrl = getAppUrl('https://www.example.com')
+```
+
+This is particularly useful in `nuxt.config.js`:
+
+```js
+// Nuxt 2
+import { getApiUrl, getServerUrl, getAppUrl } from '@attributech/nuxt-drupal-utils'
+
+export default {
+  publicRuntimeConfig: {
+    serverUrl: getServerUrl('https://default-backend.com'),
+    apiUrl: getApiUrl('https://default-backend.com'),
+    appUrl: getAppUrl('https://www.example.com')
+  }
+}
+
+// Nuxt 3
+import { getApiUrl, getServerUrl, getAppUrl } from '@attributech/nuxt-drupal-utils'
+
+export default defineNuxtConfig({
+  runtimeConfig: {
+    public: {
+      serverUrl: getServerUrl('https://default-backend.com'),
+      apiUrl: getApiUrl('https://default-backend.com'),
+      appUrl: getAppUrl('https://www.example.com')
+    }
+  }
+})
+```
+
+### As a Nuxt Module
+
+You can also use it as a Nuxt module to auto-inject the utilities:
+
+```js
+// Nuxt 2 with Bridge
+export default {
+  buildModules: [
+    '@attributech/nuxt-drupal-utils/module'
+  ]
+}
+
+// Nuxt 3
+export default defineNuxtConfig({
+  modules: [
+    '@attributech/nuxt-drupal-utils/module'
+  ]
+})
+```
+
+Then in your components:
+
+```vue
+<!-- Nuxt 2 -->
+<script>
+export default {
+  mounted() {
+    const apiUrl = this.$getApiUrl('https://default-backend.com')
+    console.log(apiUrl)
+  }
+}
+</script>
+
+<!-- Nuxt 3 -->
+<script setup>
+const { $getApiUrl } = useNuxtApp()
+const apiUrl = $getApiUrl('https://default-backend.com')
+</script>
+```
+
+## License
+
+MIT

package/dist/getApiUrl.d.ts

@@ -0,0 +1 @@
+export default function (defaultServerUrl: string): string;

package/dist/getApiUrl.js

@@ -0,0 +1,6 @@
+import getServerUrl from './getServerUrl';
+// Provides a function to determin the API endpoint to use
+export default function (defaultServerUrl) {
+    const serverUrl = getServerUrl(defaultServerUrl);
+    return `${serverUrl}/api`;
+}

package/dist/getAppUrl.d.ts

@@ -0,0 +1 @@
+export default function (defaultUrl: string): string;

package/dist/getAppUrl.js

@@ -0,0 +1,17 @@
+import getLagoonDevelopmentDomain from './getLagoonDevelopmentDomain';
+// Provides a function to determin the app url
+export default function (defaultUrl) {
+    // Override app url in case APP_URL env variable is set
+    if (process.env.APP_URL !== undefined && process.env.APP_URL !== '') {
+        return process.env.APP_URL;
+    }
+    // Build app url in case we are on a lagoon development environment
+    if (process.env.LAGOON_ENVIRONMENT_TYPE !== undefined &&
+        process.env.LAGOON_ENVIRONMENT_TYPE === 'development') {
+        const lagoonDevelopmentDomain = getLagoonDevelopmentDomain();
+        if (lagoonDevelopmentDomain !== null) {
+            return `https://frontend.${lagoonDevelopmentDomain}`;
+        }
+    }
+    return defaultUrl;
+}

package/dist/getLagoonDevelopmentDomain.d.ts

@@ -0,0 +1 @@
+export default function (): string | null;

package/dist/getLagoonDevelopmentDomain.js

@@ -0,0 +1,9 @@
+// Provides a function to build a lagoon domain for development enivronments
+export default function () {
+    if (process.env.LAGOON_ENVIRONMENT !== undefined &&
+        process.env.LAGOON_PROJECT !== undefined &&
+        process.env.LAGOON_KUBERNETES !== undefined) {
+        return `${process.env.LAGOON_ENVIRONMENT}.${process.env.LAGOON_PROJECT}.${process.env.LAGOON_KUBERNETES}`;
+    }
+    return null;
+}

package/dist/getServerUrl.d.ts

@@ -0,0 +1 @@
+export default function (defaultUrl: string): string;

package/dist/getServerUrl.js

@@ -0,0 +1,17 @@
+import getLagoonDevelopmentDomain from './getLagoonDevelopmentDomain';
+// Provides a function to determine the API endpoint to use
+export default function (defaultUrl) {
+    // Override API endpoint in case API_SERVER env variable is set
+    if (process.env.API_SERVER !== undefined && process.env.API_SERVER !== '') {
+        return process.env.API_SERVER;
+    }
+    // Set API endpoint to nginx service in case we are on lagoon and not in production
+    if (process.env.LAGOON_ENVIRONMENT_TYPE !== undefined &&
+        process.env.LAGOON_ENVIRONMENT_TYPE === 'development') {
+        const lagoonDevelopmentDomain = getLagoonDevelopmentDomain();
+        if (lagoonDevelopmentDomain !== null) {
+            return `https://nginx.${lagoonDevelopmentDomain}`;
+        }
+    }
+    return defaultUrl;
+}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import getApiUrl from './getApiUrl';
+import getAppUrl from './getAppUrl';
+import getServerUrl from './getServerUrl';
+import getLagoonDevelopmentDomain from './getLagoonDevelopmentDomain';
+export { getApiUrl, getAppUrl, getServerUrl, getLagoonDevelopmentDomain };

package/dist/index.js

@@ -0,0 +1,5 @@
+import getApiUrl from './getApiUrl';
+import getAppUrl from './getAppUrl';
+import getServerUrl from './getServerUrl';
+import getLagoonDevelopmentDomain from './getLagoonDevelopmentDomain';
+export { getApiUrl, getAppUrl, getServerUrl, getLagoonDevelopmentDomain };

package/dist/module.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@nuxt/schema").NuxtModule<any, any, false>;
+export default _default;

package/dist/module.js

@@ -0,0 +1,17 @@
+import { defineNuxtModule, addPlugin, createResolver } from '@nuxt/kit';
+export default defineNuxtModule({
+    meta: {
+        name: '@attributech/nuxt-drupal-utils',
+        configKey: 'drupalUtils',
+        compatibility: {
+            // Compatible with Nuxt 2.16+ (with Bridge) and Nuxt 3
+            nuxt: '^2.16.0 || ^3.0.0'
+        }
+    },
+    defaults: {},
+    setup(options, nuxt) {
+        const resolver = createResolver(import.meta.url);
+        // Add plugin to make utilities available
+        addPlugin(resolver.resolve('./runtime/plugin'));
+    }
+});

package/dist/runtime/plugin.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (context: any, inject: (name: string, value: any) => void) => void;
+export default _default;

package/dist/runtime/plugin.js

@@ -0,0 +1,12 @@
+import getApiUrl from '../getApiUrl';
+import getAppUrl from '../getAppUrl';
+import getServerUrl from '../getServerUrl';
+import getLagoonDevelopmentDomain from '../getLagoonDevelopmentDomain';
+// Plugin works with both Nuxt 2 + Bridge and Nuxt 3
+export default (context, inject) => {
+    // Inject utilities into the context
+    inject('getApiUrl', getApiUrl);
+    inject('getAppUrl', getAppUrl);
+    inject('getServerUrl', getServerUrl);
+    inject('getLagoonDevelopmentDomain', getLagoonDevelopmentDomain);
+};

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@attributech/nuxt-drupal-utils",
+  "version": "0.1.0",
+  "description": "Shared utilities for Nuxt 3 projects with Drupal backend",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./module": {
+      "import": "./dist/module.js",
+      "types": "./dist/module.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:ui": "vitest --ui"
+  },
+  "keywords": [
+    "nuxt",
+    "drupal",
+    "utils",
+    "lagoon"
+  ],
+  "license": "MIT",
+  "peerDependencies": {
+    "nuxt": "^2.16.0 || ^3.0.0"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^3.14.0"
+  },
+  "devDependencies": {
+    "@nuxt/types": "^2.16.0",
+    "@types/node": "^20.11.0",
+    "@vitest/coverage-v8": "^3.0.7",
+    "@vitest/ui": "^3.0.7",
+    "c8": "^10.1.3",
+    "happy-dom": "^17.2.2",
+    "typescript": "^5.6.3",
+    "vitest": "^3.0.7"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}