idenplane-vue 1.0.1

package/README.md

@@ -0,0 +1,149 @@
+# idenplane-vue
+
+Vue 3 SDK for [Idenplane](https://github.com/idenplane/idenplane) — composables, a Vue plugin, Vue Router guard, and an `AuthProvider` component.
+
+## Installation
+
+```bash
+npm install idenplane-vue idenplane-sdk vue
+```
+
+## Quick Start
+
+### 1. Install the plugin
+
+```typescript
+// main.ts
+import { createApp } from 'vue';
+import { IdenplanePlugin } from 'idenplane-vue';
+import App from './App.vue';
+
+const app = createApp(App);
+
+app.use(IdenplanePlugin, {
+  url: 'http://localhost:3000',
+  realm: 'my-realm',
+  clientId: 'my-app',
+  redirectUri: 'http://localhost:5173/callback',
+});
+
+app.mount('#app');
+```
+
+### 2. Use `useAuth` in components
+
+```vue
+<script setup lang="ts">
+import { useAuth } from 'idenplane-vue';
+
+const { isAuthenticated, user, login, logout, isLoading } = useAuth();
+</script>
+
+<template>
+  <div v-if="isLoading">Loading...</div>
+  <div v-else-if="isAuthenticated">
+    Hello, {{ user?.name }}
+    <button @click="logout">Sign out</button>
+  </div>
+  <div v-else>
+    <button @click="login()">Sign in</button>
+  </div>
+</template>
+```
+
+### 3. Protect routes with the navigation guard
+
+```typescript
+// router/index.ts
+import { createRouter, createWebHistory } from 'vue-router';
+import { createAuthGuard } from 'idenplane-vue';
+import { IdenplaneClient } from 'idenplane-sdk';
+
+const authClient = new IdenplaneClient({
+  url: 'http://localhost:3000',
+  realm: 'my-realm',
+  clientId: 'my-app',
+  redirectUri: 'http://localhost:5173/callback',
+});
+
+const router = createRouter({
+  history: createWebHistory(),
+  routes: [
+    { path: '/', component: Home },
+    {
+      path: '/dashboard',
+      component: Dashboard,
+      meta: { requiresAuth: true },
+    },
+    {
+      path: '/admin',
+      component: Admin,
+      meta: { requiresAuth: true, roles: ['admin'] },
+    },
+  ],
+});
+
+router.beforeEach(createAuthGuard({ loginRoute: '/login' }, authClient));
+
+export default router;
+```
+
+### 4. AuthProvider component (scoped context)
+
+```vue
+<!-- App.vue -->
+<template>
+  <AuthProvider
+    url="http://localhost:3000"
+    realm="my-realm"
+    client-id="my-app"
+    redirect-uri="http://localhost:5173/callback"
+  >
+    <RouterView />
+  </AuthProvider>
+</template>
+
+<script setup lang="ts">
+import { AuthProvider } from 'idenplane-vue';
+</script>
+```
+
+### 5. Permissions
+
+```vue
+<script setup lang="ts">
+import { usePermissions } from 'idenplane-vue';
+
+const { hasRole, hasPermission, roles } = usePermissions();
+</script>
+
+<template>
+  <AdminPanel v-if="hasRole('admin')" />
+</template>
+```
+
+## API Reference
+
+### Plugin
+
+- `IdenplanePlugin` — Vue plugin, call `app.use(IdenplanePlugin, IdenplaneConfig)`
+
+### Composables
+
+- `useAuth()` — `{ isAuthenticated, user, isLoading, login, logout, getToken, client }`
+- `useUser()` — `{ user, isLoading, refresh }`
+- `usePermissions()` — `{ hasRole, hasPermission, roles }`
+
+### Navigation Guard
+
+- `createAuthGuard(options?, client?)` — returns a `NavigationGuard`
+  - `options.loginRoute` — redirect path (default: `'/login'`)
+  - `options.roles` — global required roles
+
+### Components
+
+- `<AuthProvider>` — provides auth context to a component subtree
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "idenplane-vue",
+  "version": "1.0.1",
+  "description": "Vue SDK for Idenplane Identity and Access Management Server",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "peerDependencies": {
+    "idenplane-sdk": ">=1.0.0",
+    "vue": ">=3.0.0",
+    "vue-router": ">=4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "vue-router": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "devDependencies": {
+    "@vue/test-utils": "^2.4.0",
+    "idenplane-sdk": "file:../idenplane-js",
+    "jsdom": "^29.0.1",
+    "tsup": "^8.4.0",
+    "typescript": "^5.7.0",
+    "vitest": "^4.0.18",
+    "vue": "^3.5.0",
+    "vue-router": "^4.4.0"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "idenplane",
+    "oauth2",
+    "oidc",
+    "vue",
+    "vue3",
+    "authentication",
+    "composables"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/idenplane/idenplane.git",
+    "directory": "packages/idenplane-vue"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "overrides": {
+    "esbuild": ">=0.28.1"
+  }
+}