nuxt-auth-utils 0.2.0 → 0.2.1

package/README.md

@@ -166,6 +166,7 @@ It can also be set using environment variables:
 - Twitch
 - X (Twitter)
 - XSUAA
+- Yandex
 
 You can add your favorite provider by creating a new file in [src/runtime/server/lib/oauth/](./src/runtime/server/lib/oauth/).
 

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "auth-utils",
   "configKey": "auth",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "builder": {
     "@nuxt/module-builder": "0.7.1",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -43,7 +43,11 @@ const module = defineNuxtModule({
       const envPath = join(nuxt.options.rootDir, ".env");
       const envContent = await readFile(envPath, "utf-8").catch(() => "");
       if (!envContent.includes("NUXT_SESSION_PASSWORD")) {
-        await writeFile(envPath, `${envContent ? envContent + "\n" : envContent}NUXT_SESSION_PASSWORD=${runtimeConfig.session.password}`, "utf-8");
+        await writeFile(
+          envPath,
+          `${envContent ? envContent + "\n" : envContent}NUXT_SESSION_PASSWORD=${runtimeConfig.session.password}`,
+          "utf-8"
+        );
       }
     }
     runtimeConfig.oauth = defu(runtimeConfig.oauth, {});
@@ -122,6 +126,10 @@ const module = defineNuxtModule({
       clientSecret: "",
       domain: ""
     });
+    runtimeConfig.oauth.yandex = defu(runtimeConfig.oauth.yandex, {
+      clientId: "",
+      clientSecret: ""
+    });
   }
 });
 

package/dist/runtime/app/components/AuthState.vue

@@ -1,14 +1,13 @@
-<script setup>
+<script lang="ts" setup>
 import { useUserSession } from '#imports'
 
-const userSession = useUserSession()
-const { ready } = userSession
+const { loggedIn, user, clear, ready } = useUserSession()
 </script>
 
 <template>
   <slot
     v-if="ready"
-    v-bind="userSession"
+    v-bind="{ loggedIn, user, clear }"
   />
   <slot
     v-else

package/dist/runtime/server/lib/oauth/x.d.ts

@@ -14,9 +14,14 @@ export interface OAuthXConfig {
      * X OAuth Scope
      * @default []
      * @see https://developer.x.com/en/docs/authentication/oauth-2-0/user-access-token
-     * @example [ 'tweet.read','users.read','offline.access ],
+     * @example ['tweet.read', 'users.read', 'offline.access'],
      */
     scope?: string[];
+    /**
+     * Require email from user
+     * @default false
+     */
+    emailRequired?: boolean;
     /**
      * X OAuth Authorization URL
      * @default 'https://twitter.com/i/oauth2/authorize'

package/dist/runtime/server/lib/oauth/x.js

@@ -90,6 +90,30 @@ export function xEventHandler({
     ).catch((error) => {
       return error;
     });
+    if (config.emailRequired) {
+      const emailData = await $fetch("https://api.twitter.com/1.1/account/verify_credentials.json", {
+        headers: {
+          Authorization: `Bearer ${accessToken}`
+        },
+        query: {
+          include_email: "true",
+          skip_status: "true"
+        }
+      }).catch((error) => {
+        return error;
+      });
+      if (emailData && emailData.email) {
+        user.email = emailData.email;
+      } else {
+        const error = createError({
+          statusCode: 401,
+          message: "Twitter login failed: no user email found"
+        });
+        if (!onError)
+          throw error;
+        return onError(event, error);
+      }
+    }
     return onSuccess(event, {
       tokens,
       user: user?.data

package/dist/runtime/server/lib/oauth/yandex.d.ts

@@ -0,0 +1,41 @@
+import type { OAuthConfig } from '#auth-utils';
+export interface OAuthYandexConfig {
+    /**
+     * Yandex OAuth Client ID
+     * @default process.env.NUXT_OAUTH_YANDEX_CLIENT_ID
+     */
+    clientId?: string;
+    /**
+     * Yandex OAuth Client Secret
+     * @default process.env.NUXT_OAUTH_YANDEX_CLIENT_SECRET
+     */
+    clientSecret?: string;
+    /**
+     * Yandex OAuth Scope
+     * @default []
+     * @see https://yandex.ru/dev/id/doc/en/codes/code-url#optional
+     * @example ["login:avatar", "login:birthday", "login:email", "login:info", "login:default_phone"]
+     */
+    scope?: string[];
+    /**
+     * Require email from user, adds the ['login:email'] scope if not present
+     * @default false
+     */
+    emailRequired?: boolean;
+    /**
+     * Yandex OAuth Authorization URL
+     * @default 'https://oauth.yandex.ru/authorize'
+     */
+    authorizationURL?: string;
+    /**
+     * Yandex OAuth Token URL
+     * @default 'https://oauth.yandex.ru/token'
+     */
+    tokenURL?: string;
+    /**
+     * Yandex OAuth User URL
+     * @default 'https://login.yandex.ru/info'
+     */
+    userURL?: string;
+}
+export declare function yandexEventHandler({ config, onSuccess, onError, }: OAuthConfig<OAuthYandexConfig>): import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;

package/dist/runtime/server/lib/oauth/yandex.js

@@ -0,0 +1,84 @@
+import {
+  eventHandler,
+  createError,
+  getQuery,
+  getRequestURL,
+  sendRedirect
+} from "h3";
+import { withQuery, parseURL, stringifyParsedURL } from "ufo";
+import { defu } from "defu";
+import { useRuntimeConfig } from "#imports";
+export function yandexEventHandler({
+  config,
+  onSuccess,
+  onError
+}) {
+  return eventHandler(async (event) => {
+    config = defu(config, useRuntimeConfig(event).oauth?.yandex, {
+      authorizationURL: "https://oauth.yandex.ru/authorize",
+      tokenURL: "https://oauth.yandex.ru/token",
+      userURL: "https://login.yandex.ru/info"
+    });
+    const { code } = getQuery(event);
+    if (!config.clientId || !config.clientSecret) {
+      const error = createError({
+        statusCode: 500,
+        message: "Missing NUXT_OAUTH_YANDEX_CLIENT_ID or NUXT_OAUTH_YANDEX_CLIENT_SECRET env variables."
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    const redirectUrl = getRequestURL(event).href;
+    if (!code) {
+      config.scope = config.scope || [];
+      if (config.emailRequired && !config.scope.includes("login:email")) {
+        config.scope.push("login:email");
+      }
+      return sendRedirect(
+        event,
+        withQuery(config.authorizationURL, {
+          response_type: "code",
+          client_id: config.clientId,
+          redirect_uri: redirectUrl,
+          scope: config.scope.join(" ")
+        })
+      );
+    }
+    const tokens = await $fetch(config.tokenURL, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/x-www-form-urlencoded"
+      },
+      body: new URLSearchParams({
+        client_id: config.clientId,
+        client_secret: config.clientSecret,
+        grant_type: "authorization_code",
+        redirect_uri: stringifyParsedURL(parseURL(redirectUrl)),
+        code
+      }).toString()
+    }).catch((error) => {
+      return { error };
+    });
+    if (tokens.error) {
+      const error = createError({
+        statusCode: 401,
+        message: `Yandex login failed: ${tokens.error?.data?.error_description || "Unknown error"}`,
+        data: tokens
+      });
+      if (!onError)
+        throw error;
+      return onError(event, error);
+    }
+    const accessToken = tokens.access_token;
+    const user = await $fetch(config.userURL, {
+      headers: {
+        Authorization: `OAuth ${accessToken}`
+      }
+    });
+    return onSuccess(event, {
+      tokens,
+      user
+    });
+  });
+}

package/dist/runtime/server/utils/oauth.d.ts

@@ -14,6 +14,7 @@ import { paypalEventHandler } from '../lib/oauth/paypal.js';
 import { steamEventHandler } from '../lib/oauth/steam.js';
 import { xEventHandler } from '../lib/oauth/x.js';
 import { xsuaaEventHandler } from '../lib/oauth/xsuaa.js';
+import { yandexEventHandler } from '../lib/oauth/yandex.js';
 export declare const oauth: {
     githubEventHandler: typeof githubEventHandler;
     spotifyEventHandler: typeof spotifyEventHandler;
@@ -31,4 +32,5 @@ export declare const oauth: {
     steamEventHandler: typeof steamEventHandler;
     xEventHandler: typeof xEventHandler;
     xsuaaEventHandler: typeof xsuaaEventHandler;
+    yandexEventHandler: typeof yandexEventHandler;
 };

package/dist/runtime/server/utils/oauth.js

@@ -14,6 +14,7 @@ import { paypalEventHandler } from "../lib/oauth/paypal.js";
 import { steamEventHandler } from "../lib/oauth/steam.js";
 import { xEventHandler } from "../lib/oauth/x.js";
 import { xsuaaEventHandler } from "../lib/oauth/xsuaa.js";
+import { yandexEventHandler } from "../lib/oauth/yandex.js";
 export const oauth = {
   githubEventHandler,
   spotifyEventHandler,
@@ -30,5 +31,6 @@ export const oauth = {
   paypalEventHandler,
   steamEventHandler,
   xEventHandler,
-  xsuaaEventHandler
+  xsuaaEventHandler,
+  yandexEventHandler
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auth-utils",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Minimalist Auth module for Nuxt with SSR",
   "repository": "Atinux/nuxt-auth-utils",
   "license": "MIT",
@@ -25,6 +25,7 @@
     "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
     "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
     "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
     "test": "vitest run",
     "test:types": "vue-tsc --noEmit",
     "test:types:playground": "cd playground && vue-tsc --noEmit",