@owdproject/nuxt-module-atproto 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,130 @@
-# Temporary Holding Version
+<p align="center">
+  <img width="160" height="160" src="https://avatars.githubusercontent.com/u/201536780?s=160&v=4" />
+</p>
+<h1 align="center">ATProto Module</h1>
+<h3 align="center">
+  AT Protocol Module 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.
+## Overview
+
+This module for Open Web Desktop enables AT Protocol integration, including OAuth
+session management, account state, and desktop owner profile fetching.
+
+It wraps [`nuxt-atproto`](https://nuxt-atproto.pages.dev/) and exposes the
+AT Protocol composables throughout the desktop runtime.
+
+## Features
+
+- OAuth session management via `nuxt-atproto`
+- Generates `client-metadata.json` in `/public` for OAuth
+- Fetches the desktop owner's ATProto profile at build time
+- Provides `useAtprotoAccountStore` for reactive account state
+- Handles OAuth login / logout from the Account app
+
+## Requirements
+
+- `@owdproject/core` ≥ 3.4.0
+- `nuxt-atproto` ≥ 0.1.0 (installed automatically as a dependency)
+
+## Installation
+
+```bash
+pnpm desktop add module-atproto
+```
+
+## Configuration
+
+### 1. Configure `nuxt-atproto` in `nuxt.config.ts`
+
+The AT Protocol OAuth client is configured via the `atproto` key in your Nuxt
+config. This is separate from the desktop config and is required for OAuth to work:
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  atproto: {
+    serviceEndpoint: {
+      private: 'https://bsky.social',
+      public: 'https://public.api.bsky.app',
+    },
+    oauth: {
+      // Set `writeClientMetadata: true` to generate /public/client-metadata.json
+      writeClientMetadata: true,
+      clientMetadata: {
+        // Leave `remote` empty to use the generated local client-metadata.json.
+        // Set it to a URL if you host the metadata file yourself.
+        remote: '',
+        local: {
+          client_id: 'https://your-desktop.example.com/client-metadata.json',
+          client_name: 'My Desktop',
+          client_uri: 'https://your-desktop.example.com',
+          logo_uri: 'https://your-desktop.example.com/favicon.ico',
+          tos_uri: 'https://your-desktop.example.com',
+          policy_uri: 'https://your-desktop.example.com',
+          redirect_uris: ['https://your-desktop.example.com'],
+          scope: 'atproto transition:generic',
+          grant_types: ['authorization_code', 'refresh_token'],
+          response_types: ['code'],
+          token_endpoint_auth_method: 'none',
+          application_type: 'web',
+          dpop_bound_access_tokens: true,
+        },
+      },
+      signInOptions: {
+        state: '',
+        prompt: 'login',
+        scope: 'atproto',
+        ui_locales: 'en',
+      },
+    },
+    debug: false,
+  },
+})
+```
+
+### 2. Configure the desktop owner in `desktop.config.ts`
+
+```ts
+// desktop/desktop.config.ts
+export default defineDesktopConfig({
+  // ...
+  atprotoDesktop: {
+    owner: {
+      did: 'did:plc:your-did-here',
+    },
+    name: {
+      title: 'my',
+      affix: 'Desktop',
+    },
+  },
+})
+```
+
+The `owner.profile` field is populated automatically at build time by fetching
+the profile from the ATProto public API.
+
+## Composables
+
+The following composables are auto-imported from `nuxt-atproto`:
+
+| Composable | Description |
+|---|---|
+| `useAtprotoSession()` | Reactive OAuth session (`session`, `isLogged`, `status`) |
+| `useAtprotoAuth()` | `signIn()`, `signInWithHandle()`, `signOut()`, `restore()` |
+| `useAtprotoAgent(scope)` | Cached AT Protocol agent (`'authenticated'`, `'public'`, or a PDS URL) |
+
+> **Legacy API** (`useAtproto()`, `useAgent()`) still works but is deprecated
+> in `nuxt-atproto` ≥ 0.1.0. Prefer the composables above.
+
+## Stores
+
+| Store | Pinia id | Description |
+|---|---|---|
+| `useAtprotoAccountStore` | `desktop/atproto/account` | Account profile, session state, handle resolver |
+
+The store persists `handleResolver` via `module-persistence` (if installed).
+
+## License
+
+This module is released under the [MIT License](LICENSE).

package/dist/module.d.mts

@@ -0,0 +1,5 @@
+import { NuxtModule } from '@nuxt/schema';
+
+declare const module$1: NuxtModule<any>;
+
+export { module$1 as default };

package/dist/module.json

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

package/dist/module.mjs

@@ -0,0 +1,40 @@
+import { createResolver, installModule, addImportsDir, addPlugin } from '@nuxt/kit';
+import { defineDesktopModule } from '@owdproject/nuxt/kit';
+import { getAtprotoDesktopOwner } from '../dist/runtime/utils/utilAtprotoDesktop.js';
+import { AtpAgent } from '@atproto/api';
+
+const { resolve } = createResolver(import.meta.url);
+const module$1 = defineDesktopModule({
+  meta: {
+    name: "desktop-module-atproto",
+    configKey: "atprotoDesktop"
+  },
+  defaults: {
+    owner: {
+      did: "did:plc:iaf5ejdchj6nydfxmcrq5rm6"
+    },
+    name: {
+      title: "atproto",
+      affix: "OS"
+    }
+  },
+  async setup(options, _nuxt) {
+    await installModule("nuxt-atproto", {});
+    const atprotoConfig = _nuxt.options.runtimeConfig.public.atproto;
+    const publicServiceEndpoint = atprotoConfig && atprotoConfig.serviceEndpoint && atprotoConfig.serviceEndpoint.public;
+    options.owner.profile = await getAtprotoDesktopOwner(
+      new AtpAgent({
+        service: publicServiceEndpoint ?? "https://public.api.bsky.app"
+      }),
+      options.owner.did
+    );
+    addImportsDir(resolve("./runtime/composables"));
+    addImportsDir(resolve("./runtime/stores"));
+    addPlugin({
+      src: resolve("./runtime/plugin"),
+      mode: "client"
+    });
+  }
+});
+
+export { module$1 as 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,22 @@
+import { useAtprotoAccountStore } from "./stores/storeAtprotoAccount.js";
+import { defineNuxtPlugin } from "nuxt/app";
+import { useAtprotoSession, useAtprotoAgent } from "#imports";
+export default defineNuxtPlugin({
+  name: "desktop-plugin-atproto",
+  parallel: true,
+  async setup(nuxtApp) {
+    const atprotoAccountStore = useAtprotoAccountStore();
+    nuxtApp.hook("app:mounted", async () => {
+      const { isLogged, session } = useAtprotoSession();
+      if (isLogged.value && session.value) {
+        const agent = useAtprotoAgent("public");
+        atprotoAccountStore.setAccountState("fetching", true);
+        await agent.getProfile({
+          actor: session.value.sub
+        }).then((profile) => {
+          atprotoAccountStore.setAccount(profile.data);
+        });
+      }
+    });
+  }
+});

package/dist/runtime/stores/storeAtprotoAccount.d.ts

@@ -0,0 +1,13 @@
+export declare const useAtprotoAccountStore: import("pinia").SetupStoreDefinition<"desktop/atproto/account", {
+    session: import("vue").Ref<any, any>;
+    account: import("vue").Ref<any, any>;
+    handleResolver: import("vue").Ref<string, string>;
+    handleResolverHostname: import("vue").ComputedRef<string>;
+    state: {
+        fetching: boolean;
+    };
+    isAccountLogged: import("vue").ComputedRef<boolean>;
+    setAccount: (value: any | undefined) => void;
+    setAccountState: (key: "fetching", value: boolean) => void;
+    reset: () => void;
+}>;

package/dist/runtime/stores/storeAtprotoAccount.js

@@ -0,0 +1,51 @@
+import { defineStore } from "pinia";
+import { ref, reactive, computed } from "@vue/reactivity";
+import { useRuntimeConfig } from "nuxt/app";
+export const useAtprotoAccountStore = defineStore(
+  "desktop/atproto/account",
+  () => {
+    const runtimeConfig = useRuntimeConfig();
+    const session = ref();
+    const account = ref();
+    const handleResolver = ref(
+      runtimeConfig.public.atproto?.serviceEndpoint?.private ?? "https://bsky.social"
+    );
+    const state = reactive({
+      fetching: false
+    });
+    const isAccountLogged = computed(() => {
+      return !!account.value;
+    });
+    const handleResolverHostname = computed(() => {
+      return new URL(handleResolver.value).hostname;
+    });
+    function setAccount(value) {
+      account.value = value;
+      state.fetching = false;
+    }
+    function setAccountState(key, value) {
+      state[key] = value;
+    }
+    function reset() {
+      session.value = void 0;
+      account.value = void 0;
+    }
+    return {
+      session,
+      account,
+      handleResolver,
+      handleResolverHostname,
+      state,
+      isAccountLogged,
+      setAccount,
+      setAccountState,
+      reset
+    };
+  },
+  {
+    persistedState: {
+      persist: true,
+      includePaths: ["handleResolver"]
+    }
+  }
+);

package/dist/runtime/utils/utilAtprotoDesktop.d.ts

@@ -0,0 +1 @@
+export declare function getAtprotoDesktopOwner(agent: any, did: string): Promise<any>;

package/dist/runtime/utils/utilAtprotoDesktop.js

@@ -0,0 +1,3 @@
+export async function getAtprotoDesktopOwner(agent, did) {
+  return agent.getProfile({ actor: did }).then((result) => result.data);
+}

package/dist/runtime/utils/utilRoute.d.ts

@@ -0,0 +1,3 @@
+export declare function routeAtprotoOS(path?: string): string;
+export declare function routeBluesky(path?: string): string;
+export declare function routeBlueskyProfile(handle: string): string;

package/dist/runtime/utils/utilRoute.js

@@ -0,0 +1,9 @@
+export function routeAtprotoOS(path) {
+  return "https://github.com/atproto-os" + path;
+}
+export function routeBluesky(path) {
+  return "https://bsky.app" + path;
+}
+export function routeBlueskyProfile(handle) {
+  return routeBluesky(`/profile/${handle}`);
+}

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,71 @@
 {
   "name": "@owdproject/nuxt-module-atproto",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "4.0.0-alpha.3",
+  "keywords": [
+    "owd-client",
+    "owd-modules"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/atproto-os/module-atproto",
+  "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"
+    },
+    "./runtime/*": {
+      "types": "./src/runtime/*",
+      "import": "./src/runtime/*"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "nx": {
+    "name": "module-atproto"
+  },
+  "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:-/module-atproto/} nuxt generate playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && cd playground && pnpm exec nuxt prepare",
+    "validate": "desktop validate ."
+  },
+  "dependencies": {
+    "@atproto/api": "^0.20.6",
+    "@nuxt/kit": "^4.6.2",
+    "nuxt-atproto": "^0.1.1",
+    "@owdproject/nuxt": "^4.0.0-alpha.3"
+  },
+  "devDependencies": {
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.6.2",
+    "@owdproject/core": "^4.0.0-alpha.3",
+    "nuxt": "^4.6.2",
+    "typescript": "~6.0.3"
+  },
+  "peerDependencies": {
+    "@owdproject/core": "^4.0.0-alpha.3",
+    "@owdproject/nuxt": "^4.0.0-alpha.3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "alpha",
+    "registry": "https://registry.npmjs.org/"
+  }
+}