@owdproject/nuxt-app-about 0.0.0-stage → 4.0.0-alpha.3

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025  Open Web Desktop Team ~ github.com/owdproject
+
+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

@@ -1,3 +1,50 @@
-# Temporary Holding Version
+<p align="center">
+  <img width="160" height="160" src="https://avatars.githubusercontent.com/u/65117737?s=160&v=4" />
+</p>
+<h1 align="center">About</h1>
+<h3 align="center">
+  About App for Open Web Desktop.
+</h3>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<br />
+
+## Overview
+
+This app for Open Web Desktop displays the version and other system information.
+
+[Demo](https://owdproject.github.io/nuxt-app-about/) · [Documentation](https://owdproject.github.io/docs/) · [Support](https://github.com/sponsors/owdproject)
+
+## Installation
+
+```bash
+pnpm desktop add app-about
+```
+
+## Configuration
+
+Add the app to your `desktop.config.ts`:
+
+```ts
+export default defineDesktopConfig({
+  apps: [
+    '@owdproject/nuxt-app-about'
+  ],
+  about: {
+    title: 'Open Web Desktop',
+    subtitle: 'github.com/owdproject/nuxt-desktop',
+    href: 'https://github.com/owdproject/nuxt-desktop',
+    versionText: 'v{desktopVersion} on Nuxt {nuxtVersion}',
+    icons: [
+      {
+        title: 'Open Web Desktop',
+        name: 'mdi:hexagon-multiple-outline',
+        size: 24,
+      },
+    ]
+  }
+})
+```
+
+## License
+
+This application is released under the [MIT License](LICENSE).

package/dist/module.d.mts

@@ -0,0 +1,17 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+declare const _default: _nuxt_schema.NuxtModule<{
+    title: string;
+    subtitle: string;
+    href: string;
+    versionText: string;
+    icons: never[];
+}, {
+    title: string;
+    subtitle: string;
+    href: string;
+    versionText: string;
+    icons: never[];
+}, false>;
+
+export { _default as default };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "desktop-app-about",
+  "configKey": "about",
+  "version": "4.0.0-alpha.3",
+  "builder": {
+    "@nuxt/module-builder": "1.0.3",
+    "unbuild": "3.6.1"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,73 @@
+import { defineNuxtModule, createResolver, addComponentsDir, addPlugin } from '@nuxt/kit';
+import { registerTailwindPath } from '@owdproject/nuxt-kit-tailwind/kit/registerTailwindPath';
+
+const module$1 = defineNuxtModule({
+  meta: {
+    name: "desktop-app-about",
+    configKey: "about"
+  },
+  defaults: {
+    title: "Open Web Desktop",
+    subtitle: "github.com/owdproject/nuxt-desktop",
+    href: "https://github.com/owdproject/nuxt-desktop",
+    versionText: "Nuxt {nuxtVersion} + Desktop {desktopVersion}",
+    icons: []
+  },
+  async setup(options, nuxt) {
+    const { resolve } = createResolver(import.meta.url);
+    const coreVersion = nuxt.options.runtimeConfig.public.desktop?.coreVersion ?? "?.?";
+    options.versionText = options.versionText.replace("{desktopVersion}", coreVersion).replace("{nuxtVersion}", nuxt._version || "unknown");
+    if (!options.icons || Array.isArray(options.icons) && options.icons.length === 0) {
+      options.icons = [
+        {
+          title: "Vue.js",
+          name: "simple-icons:vuedotjs",
+          size: 18,
+          style: "margin: 3px -5px 0 0"
+        },
+        {
+          title: "Nuxt.js",
+          name: "simple-icons:nuxt",
+          size: 25,
+          style: "margin-top: -1px"
+        },
+        {
+          title: "TypeScript",
+          name: "simple-icons:typescript",
+          size: 18,
+          style: "margin-top: 3px"
+        },
+        {
+          title: "PrimeVue",
+          name: "simple-icons:primevue",
+          size: 18,
+          style: "margin-top: 3px"
+        },
+        {
+          title: "Tailwind CSS",
+          name: "simple-icons:tailwindcss",
+          size: 18,
+          style: "margin-top: 3px"
+        }
+      ];
+    }
+    nuxt.options.runtimeConfig.public.desktop ??= {};
+    nuxt.options.runtimeConfig.public.desktop.about = options;
+    {
+      addComponentsDir({
+        path: resolve("./runtime/components")
+      });
+    }
+    {
+      addPlugin(resolve("./runtime/plugin"));
+    }
+    {
+      registerTailwindPath(
+        nuxt,
+        resolve("./runtime/components/**/*.{vue,mjs,ts}")
+      );
+    }
+  }
+});
+
+export { module$1 as default };

package/dist/runtime/app.config.d.ts

@@ -0,0 +1,31 @@
+declare const _default: {
+    id: string;
+    title: string;
+    category: string;
+    singleton: boolean;
+    icon: string;
+    windows: {
+        main: {
+            component: () => Promise<any>;
+            resizable: boolean;
+            size: {
+                width: number;
+                height: number;
+            };
+        };
+    };
+    entries: {
+        about: {
+            command: string;
+        };
+    };
+    terminal: {
+        about: {
+            description: string;
+        };
+    };
+    commands: {
+        about: (app: any) => any;
+    };
+};
+export default _default;

package/dist/runtime/app.config.js

@@ -0,0 +1,38 @@
+export default {
+  id: "org.owdproject.about",
+  title: "About",
+  category: "system-tools",
+  singleton: true,
+  icon: "mdi:hexagon-multiple-outline",
+  windows: {
+    main: {
+      component: () => import("./components/Window/WindowAbout.vue"),
+      resizable: false,
+      size: {
+        width: 448,
+        height: 240
+      }
+    }
+  },
+  entries: {
+    about: {
+      command: "about"
+    }
+  },
+  terminal: {
+    about: {
+      description: "Open the About window"
+    }
+  },
+  commands: {
+    about: (app) => {
+      const existing = app.getFirstWindowByModel("main");
+      if (existing) {
+        existing.actions.setActive(true);
+        existing.actions.bringToFront();
+        return existing;
+      }
+      return app.openWindow("main");
+    }
+  }
+};

package/dist/runtime/components/Window/WindowAbout.d.vue.ts

@@ -0,0 +1,6 @@
+type __VLS_Props = {
+    window?: IWindowController;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/components/Window/WindowAbout.vue

@@ -0,0 +1,86 @@
+<script setup>
+import { useRuntimeConfig } from "#imports";
+defineProps({
+  window: { type: null, required: false }
+});
+const runtimeConfig = useRuntimeConfig();
+</script>
+
+<template>
+  <DesktopWindow :window="window" :content="{ centered: true }">
+    <div class="about">
+      <h2
+        class="about__title"
+        v-text="runtimeConfig.public.desktop.about.title"
+      />
+      <a
+        class="about__link"
+        :href="runtimeConfig.public.desktop.about.href"
+        target="_blank"
+        v-text="runtimeConfig.public.desktop.about.subtitle"
+      />
+
+      <div
+        class="about__version"
+        v-text="runtimeConfig.public.desktop.about.versionText"
+      />
+
+      <div class="about__powered-by">
+        <ul>
+          <li
+            v-for="icon of runtimeConfig.public.desktop.about.icons"
+            :key="icon.name"
+          >
+            <a v-bind="typeof icon.link === 'string' ? { href: icon.link } : icon.link">
+              <Icon
+                :title="icon.title"
+                :name="icon.name"
+                :size="icon.size"
+                :style="icon.style"
+              />
+            </a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </DesktopWindow>
+</template>
+
+<style scoped>
+.about {
+  margin: 0 auto;
+  text-align: center;
+}
+.about__title {
+  margin: 0 0 4px;
+  font-size: 1.5rem;
+  font-weight: 600;
+  line-height: 1.2;
+}
+.about__link {
+  display: inline-block;
+  font-size: 14px;
+  opacity: 0.75;
+}
+.about__version {
+  margin: 16px 0;
+  font-size: 18px;
+  opacity: 0.3;
+}
+.about__powered-by {
+  margin-top: 12px;
+  opacity: 0.5;
+}
+.about__powered-by ul {
+  display: flex;
+  margin: 0 auto;
+  max-width: min-content;
+  line-height: 23px;
+  text-align: right;
+  text-transform: uppercase;
+  list-style-type: none;
+}
+.about__powered-by ul li {
+  margin: 0 8px;
+}
+</style>

package/dist/runtime/components/Window/WindowAbout.vue.d.ts

@@ -0,0 +1,6 @@
+type __VLS_Props = {
+    window?: IWindowController;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/plugin.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("nuxt/app").Plugin<Record<string, unknown>> & import("nuxt/app").ObjectPlugin<Record<string, unknown>>;
+export default _default;

package/dist/runtime/plugin.js

@@ -0,0 +1,10 @@
+import { defineNuxtPlugin } from "nuxt/app";
+import { defineDesktopApp } from "@owdproject/nuxt/kit/defineDesktopApp";
+import configAppAbout from "./app.config.js";
+export default defineNuxtPlugin({
+  name: "desktop-app-about-register",
+  async setup() {
+    if (import.meta.server) return;
+    await defineDesktopApp(configAppAbout);
+  }
+});

package/dist/runtime/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../.nuxt/tsconfig.server.json",
+}

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.mjs'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module.mjs'

package/package.json

@@ -1,6 +1,78 @@
 {
   "name": "@owdproject/nuxt-app-about",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "4.0.0-alpha.3",
+  "description": "About App for your Open Web Desktop client",
+  "keywords": [
+    "owd-client",
+    "owd-apps",
+    "owd-modules"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/owdproject/nuxt-app-about",
+  "author": {
+    "name": "Open Web Desktop Team",
+    "url": "https://github.com/owdproject"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "development": "./src/module.ts",
+      "import": "./dist/module.mjs",
+      "default": "./dist/module.mjs"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepack": "nuxt-module-build build",
+    "dev": "pnpm run dev:prepare && cd playground && pnpm exec nuxt dev",
+    "dev:build": "nuxt build playground",
+    "dev:generate": "NUXT_APP_BASE_URL=${NUXT_APP_BASE_URL:-/app-about/} nuxt generate playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && cd playground && pnpm exec nuxt prepare",
+    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
+    "validate": "desktop validate .",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^4.4.6",
+    "@owdproject/nuxt-kit-tailwind": "^4.0.0-alpha.3",
+    "@owdproject/nuxt": "^4.0.0-alpha.3"
+  },
+  "peerDependencies": {
+    "@owdproject/core": "^4.0.0-alpha.3",
+    "@owdproject/nuxt": "^4.0.0-alpha.3"
+  },
+  "devDependencies": {
+    "@owdproject/core": "^4.0.0-alpha.3",
+    "@nuxt/devtools": "^3.2.4",
+    "@nuxt/eslint-config": "^1.15.2",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.4.6",
+    "@nuxt/test-utils": "^4.0.3",
+    "@types/node": "latest",
+    "changelogen": "^0.6.2",
+    "eslint": "^10.4.0",
+    "nuxt": "^4.4.6",
+    "typescript": "~6.0.3",
+    "vitest": "^4.1.7",
+    "vue-tsc": "^3.3.1"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "alpha",
+    "registry": "https://registry.npmjs.org/"
+  }
+}