@stacksjs/socials 0.70.23

package/README.md

@@ -0,0 +1,65 @@
+# Stacks Socials
+
+A simple and elegant social authentication package for Stacks, inspired by Laravel's Socialite.
+
+## ☘️ Features
+
+- 🔑 Easy OAuth Authentication
+- 🔌 Support for Multiple Providers (GitHub, Google, Facebook, etc.)
+- ⚡️ Simple & Intuitive API
+- 🛠️ Customizable Provider Configuration
+- 🔒 Secure Token Handling
+- 🎯 TypeScript Support
+
+## 🤖 Usage
+
+```bash
+bun install -d @stacksjs/socials
+```
+
+Now, you can use it in your project:
+
+```js
+import { Socials } from '@stacksjs/socials'
+
+// Configure your social provider
+const github = Socials.driver('github')
+
+// Redirect to provider
+const authUrl = await github.redirect()
+
+// Handle callback
+const user = await github.user()
+```
+
+Learn more in the docs.
+
+## 🧪 Testing
+
+```bash
+bun test
+```
+
+## 📈 Changelog
+
+Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
+
+## 🚜 Contributing
+
+Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
+
+## 🏝 Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
+
+For casual chit-chat with others using this package:
+
+[Join the Stacks Discord Server](https://discord.gg/stacksjs)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
+
+Made with 💙

package/dist/index.js

@@ -0,0 +1,2 @@
+// @bun
+var X=import.meta.require;import{fetcher as Y}from"@stacksjs/api";import{config as M}from"@stacksjs/config";class K{clientId;clientSecret;redirectUrl;parameters={};_scopes=[];scopeSeparator=",";_stateless=!1;_usesPKCE=!1;user=null;constructor(w){this.clientId=w.clientId,this.clientSecret=w.clientSecret,this.redirectUrl=w.redirectUrl}getCodeFields(w=null){let z={client_id:this.clientId,redirect_uri:this.redirectUrl,scope:this.formatScopes(this.getScopes(),this.scopeSeparator),response_type:"code"};if(this.usesState())z.state=w;if(this.usesPKCE())z.code_challenge=this.getCodeChallenge(),z.code_challenge_method=this.getCodeChallengeMethod();return{...z,...this.parameters}}formatScopes(w,z){return w.join(z)}async userFromToken(w){return{...await this.getUserByToken(w),token:w}}scopes(w){let z=Array.isArray(w)?w:[w];return this._scopes=[...new Set([...this._scopes,...z])],this}setScopes(w){let z=Array.isArray(w)?w:[w];return this._scopes=[...new Set(z)],this}getScopes(){return this._scopes}setRedirectUrl(w){if(typeof w!=="string"||w.length===0)throw Error("[socials] setRedirectUrl requires a non-empty string");let z;try{z=new URL(w)}catch{throw Error(`[socials] setRedirectUrl: invalid URL: ${w}`)}if(z.protocol!=="https:"&&z.protocol!=="http:")throw Error(`[socials] setRedirectUrl protocol must be http(s)://, got ${z.protocol}`);return this.redirectUrl=w,this}usesState(){return!this._stateless}validateState(w,z){if(typeof w!=="string"||typeof z!=="string")return!1;if(w.length===0||z.length===0)return!1;if(w.length!==z.length)return!1;try{let{timingSafeEqual:D}=X("crypto");return D(Buffer.from(w,"utf8"),Buffer.from(z,"utf8"))}catch{let D=0;for(let F=0;F<w.length;F++)D|=w.charCodeAt(F)^z.charCodeAt(F);return D===0}}isStateless(){return this._stateless}stateless(){return this._stateless=!0,this}getState(){let w=new Uint8Array(32);return crypto.getRandomValues(w),Array.from(w).map((z)=>z.toString(16).padStart(2,"0")).join("")}usesPKCE(){return this._usesPKCE}enablePKCE(){return this._usesPKCE=!0,this}getCodeVerifier(){let w=new Uint8Array(48);return crypto.getRandomValues(w),Array.from(w).map((z)=>z.toString(16).padStart(2,"0")).join("")}async getCodeChallenge(){let z=new TextEncoder().encode(this.getCodeVerifier()),D=await crypto.subtle.digest("SHA-256",z),{Buffer:F}=await import("buffer");return F.from(new Uint8Array(D)).toString("base64url")}getCodeChallengeMethod(){return"S256"}with(w){return this.parameters=w,this}buildAuthUrlFromBase(w,z){let D=new URLSearchParams(this.getCodeFields(z));return`${w}?${D.toString()}`}}class G extends Error{constructor(w){super(w);this.name="ConfigException"}}class $ extends K{baseUrl="https://www.facebook.com";apiUrl="https://graph.facebook.com";getConfig(){let w={clientId:M.services.facebook?.clientId??"",clientSecret:M.services.facebook?.clientSecret??"",redirectUrl:M.services.facebook?.redirectUrl??"",scopes:M.services.facebook?.scopes??["email","public_profile"]};return this.setScopes(w.scopes),w}async getAuthUrl(){let w=this.getState(),{clientId:z,redirectUrl:D,scopes:F}=this.getConfig();return this.validateConfig(),`${this.baseUrl}/v18.0/dialog/oauth?${new URLSearchParams({client_id:z,redirect_uri:D,scope:F.join(","),state:w,response_type:"code"}).toString()}`}async getAccessToken(w){let{clientId:z,clientSecret:D,redirectUrl:F}=this.getConfig();this.validateConfig();let J=await Y.get(`${this.apiUrl}/v18.0/oauth/access_token?${new URLSearchParams({client_id:z,client_secret:D,redirect_uri:F,code:w}).toString()}`);if(J.data.error)throw Error(`Facebook OAuth error: ${J.data.error.message}`);return J.data.access_token}async getUserByToken(w){let z=await Y.get(`${this.apiUrl}/v18.0/me?${new URLSearchParams({access_token:w,fields:"id,name,email,picture"}).toString()}`);return{id:z.data.id,nickname:null,name:z.data.name,email:z.data.email??null,avatar:z.data.picture?.data.url??null,token:w,raw:z.data}}validateConfig(){let{clientId:w,clientSecret:z,redirectUrl:D}=this.getConfig();if(!w)throw new G("Facebook client ID not provided");if(!z)throw new G("Facebook client secret not provided");if(!D)throw new G("Facebook redirect URL not provided")}getTokenUrl(){return`${this.apiUrl}/v18.0/oauth/access_token`}}import{fetcher as W}from"@stacksjs/api";import{config as N}from"@stacksjs/config";class H extends K{baseUrl="https://github.com";apiUrl="https://api.github.com";getConfig(){let w={clientId:N.services.github?.clientId??"",clientSecret:N.services.github?.clientSecret??"",redirectUrl:N.services.github?.redirectUrl??"",scopes:N.services.github?.scopes??["read:user","user:email"]};return this.setScopes(w.scopes),w}async getAuthUrl(){let w=this.getState(),{clientId:z,redirectUrl:D,scopes:F}=this.getConfig();return this.validateConfig(),`${this.baseUrl}/login/oauth/authorize?${new URLSearchParams({client_id:z,redirect_uri:D,scope:F.join(" "),state:w,response_type:"code"}).toString()}`}async getAccessToken(w){let{clientId:z,clientSecret:D,redirectUrl:F}=this.getConfig();this.validateConfig();let J=await W.post(`${this.baseUrl}/login/oauth/access_token`,{client_id:z,client_secret:D,code:w,redirect_uri:F});if(J.data.error)throw Error(`GitHub OAuth error: ${J.data.error_description}`);return J.data.access_token}async getUserByToken(w){let[z,D]=await Promise.all([W.withHeaders({Accept:"application/vnd.github.v3+json",Authorization:`token ${w}`}).get(`${this.apiUrl}/user`),W.withHeaders({Accept:"application/vnd.github.v3+json",Authorization:`token ${w}`}).get(`${this.apiUrl}/user/emails`)]);return{id:z.data.id.toString(),nickname:z.data.login,name:z.data.name,email:this.getEmail(D.data)??z.data.email??null,avatar:z.data.avatar_url,token:w,raw:z.data}}getEmail(w){if(!Array.isArray(w)||w.length===0)return null;let z=w.find((F)=>F.primary&&F.verified),D=w.find((F)=>F.verified);return(z||D||w.find((F)=>F.primary)||w[0])?.email??null}validateConfig(){let{clientId:w,clientSecret:z,redirectUrl:D}=this.getConfig();if(!w)throw new G("GitHub client ID not provided");if(!z)throw new G("GitHub client secret not provided");if(!D)throw new G("GitHub redirect URL not provided")}getTokenUrl(){return`${this.baseUrl}/login/oauth/access_token`}}import{fetcher as Z}from"@stacksjs/api";import{config as O}from"@stacksjs/config";class q extends K{baseUrl="https://accounts.google.com";apiUrl="https://www.googleapis.com";getConfig(){let w={clientId:O.services.google?.clientId??"",clientSecret:O.services.google?.clientSecret??"",redirectUrl:O.services.google?.redirectUrl??"",scopes:O.services.google?.scopes??["openid","email"]};return this.setScopes(w.scopes),w}async getAuthUrl(){let w=this.getState(),{clientId:z,redirectUrl:D,scopes:F}=this.getConfig();return this.validateConfig(),`${this.baseUrl}/o/oauth2/v2/auth?${new URLSearchParams({client_id:z,redirect_uri:D,scope:F.join(" "),state:w,response_type:"code",access_type:"offline",prompt:"consent"}).toString()}`}async getAccessToken(w){let{clientId:z,clientSecret:D,redirectUrl:F}=this.getConfig();this.validateConfig();let J=await Z.post(`${this.baseUrl}/oauth2/v4/token`,{client_id:z,client_secret:D,code:w,redirect_uri:F,grant_type:"authorization_code"});if(J.data.error)throw Error(`Google OAuth error: ${J.data.error_description}`);return J.data.access_token}async getUserByToken(w){let z=await Z.withHeaders({Authorization:`Bearer ${w}`}).get(`${this.apiUrl}/oauth2/v2/userinfo`);return{id:z.data.id,nickname:z.data.given_name,name:z.data.name,email:z.data.email,avatar:z.data.picture,token:w,raw:z.data}}validateConfig(){let{clientId:w,clientSecret:z,redirectUrl:D}=this.getConfig();if(!w)throw new G("Google client ID not provided");if(!z)throw new G("Google client secret not provided");if(!D)throw new G("Google redirect URL not provided")}getTokenUrl(){return`${this.baseUrl}/oauth2/v4/token`}}import{Buffer as L}from"buffer";import{createHash as B,randomBytes as P}from"crypto";import{fetcher as _}from"@stacksjs/api";import{config as Q}from"@stacksjs/config";class E extends K{baseUrl="https://twitter.com";apiUrl="https://api.twitter.com";codeVerifier=null;getConfig(){let w={clientId:Q.services.twitter?.clientId??"",clientSecret:Q.services.twitter?.clientSecret??"",redirectUrl:Q.services.twitter?.redirectUrl??"",scopes:Q.services.twitter?.scopes??["users.read","tweet.read"]};return this.setScopes(w.scopes),w}generateCodeVerifier(){return P(32).toString("base64").replace(/[^a-z0-9]/gi,"").substring(0,128)}generateCodeChallenge(w){return B("sha256").update(w).digest("base64").replace(/\+/g,"-").replace(/\//g,"_").replace(/=/g,"")}async getAuthUrl(){let w=this.getState(),{clientId:z,redirectUrl:D,scopes:F}=this.getConfig();this.validateConfig(),this.codeVerifier=this.generateCodeVerifier();let J=this.generateCodeChallenge(this.codeVerifier);return`${this.baseUrl}/i/oauth2/authorize?${new URLSearchParams({client_id:z,redirect_uri:D,scope:F.join(" "),state:w,response_type:"code",code_challenge:J,code_challenge_method:"S256"}).toString()}`}async getAccessToken(w){let{clientId:z,clientSecret:D,redirectUrl:F}=this.getConfig();if(this.validateConfig(),!this.codeVerifier)throw Error("Code verifier not found. Please ensure getAuthUrl() is called first.");let J=L.from(`${z}:${D}`).toString("base64"),T=await _.withHeaders({Authorization:`Basic ${J}`,"Content-Type":"application/x-www-form-urlencoded"}).post(`${this.apiUrl}/2/oauth2/token`,{code:w,grant_type:"authorization_code",redirect_uri:F,code_verifier:this.codeVerifier});if(T.data.error)throw Error(`Twitter OAuth error: ${T.data.error_description}`);return T.data.access_token}async getUserByToken(w){let z=await _.withHeaders({Authorization:`Bearer ${w}`}).get(`${this.apiUrl}/2/users/me?user.fields=profile_image_url`);return{id:z.data.id,nickname:z.data.username,name:z.data.name,email:z.data.email??null,avatar:z.data.profile_image_url??null,token:w,raw:z.data}}validateConfig(){let{clientId:w,clientSecret:z,redirectUrl:D}=this.getConfig();if(!w)throw new G("Twitter client ID not provided");if(!z)throw new G("Twitter client secret not provided");if(!D)throw new G("Twitter redirect URL not provided")}getTokenUrl(){return`${this.apiUrl}/2/oauth2/token`}}export{E as TwitterProvider,q as GoogleProvider,H as GitHubProvider,$ as FacebookProvider};

package/dist/src/drivers/facebook.d.ts

@@ -0,0 +1,11 @@
+import { AbstractProvider } from '../abstract';
+import type { ProviderInterface, SocialUser } from '../types';
+export declare class FacebookProvider extends AbstractProvider implements ProviderInterface {
+  protected baseUrl: string;
+  protected apiUrl: string;
+  getAuthUrl(): Promise<string>;
+  getAccessToken(code: string): Promise<string>;
+  getUserByToken(token: string): Promise<SocialUser>;
+  protected validateConfig(): void;
+  protected getTokenUrl(): string;
+}

package/dist/src/drivers/github.d.ts

@@ -0,0 +1,12 @@
+import { AbstractProvider } from '../abstract';
+import type { GitHubEmail, ProviderInterface, SocialUser } from '../types';
+export declare class GitHubProvider extends AbstractProvider implements ProviderInterface {
+  protected baseUrl: string;
+  protected apiUrl: string;
+  getAuthUrl(): Promise<string>;
+  getAccessToken(code: string): Promise<string>;
+  getUserByToken(token: string): Promise<SocialUser>;
+  protected getEmail(emails: GitHubEmail[]): string | null;
+  protected validateConfig(): void;
+  protected getTokenUrl(): string;
+}

package/dist/src/drivers/google.d.ts

@@ -0,0 +1,11 @@
+import { AbstractProvider } from '../abstract';
+import type { ProviderInterface, SocialUser } from '../types';
+export declare class GoogleProvider extends AbstractProvider implements ProviderInterface {
+  protected baseUrl: string;
+  protected apiUrl: string;
+  getAuthUrl(): Promise<string>;
+  getAccessToken(code: string): Promise<string>;
+  getUserByToken(token: string): Promise<SocialUser>;
+  protected validateConfig(): void;
+  protected getTokenUrl(): string;
+}

package/dist/src/drivers/index.d.ts

@@ -0,0 +1,4 @@
+export * from './facebook';
+export * from './github';
+export * from './google';
+export * from './twitter';

package/dist/src/drivers/twitter.d.ts

@@ -0,0 +1,11 @@
+import { AbstractProvider } from '../abstract';
+import type { ProviderInterface, SocialUser } from '../types';
+export declare class TwitterProvider extends AbstractProvider implements ProviderInterface {
+  protected baseUrl: string;
+  protected apiUrl: string;
+  getAuthUrl(): Promise<string>;
+  getAccessToken(code: string): Promise<string>;
+  getUserByToken(token: string): Promise<SocialUser>;
+  protected validateConfig(): void;
+  protected getTokenUrl(): string;
+}

package/dist/src/index.d.ts

@@ -0,0 +1 @@
+export * from './drivers';

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@stacksjs/socials",
+  "type": "module",
+  "version": "0.70.23",
+  "description": "A simple and elegant social authentication package for Stacks.",
+  "author": "Chris Breuer",
+  "contributors": [
+    "Chris Breuer <chris@stacksjs.com>"
+  ],
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/storage/framework/core/socials#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./storage/framework/core/socials"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "social-auth",
+    "oauth",
+    "socials",
+    "stacks"
+  ],
+  "exports": {
+    ".": {
+      "bun": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./*": {
+      "bun": "./src/*",
+      "import": "./dist/*"
+    }
+  },
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "README.md",
+    "dist"
+  ],
+  "scripts": {
+    "build": "bun build.ts",
+    "typecheck": "bun tsc --noEmit",
+    "prepublishOnly": "bun run build"
+  },
+  "devDependencies": {
+    "better-dx": "^0.2.12",
+    "@stacksjs/error-handling": "0.70.23",
+    "@stacksjs/router": "0.70.23"
+  }
+}