@lynq/github 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 hogekai
+
+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/dist/index.d.ts

@@ -0,0 +1,52 @@
+import { ToolContext, ToolMiddleware, MCPServer } from '@lynq/lynq';
+
+interface GitHubOptions {
+    /** Middleware name. Default: "github" */
+    name?: string;
+    /** GitHub OAuth App client ID. */
+    clientId: string;
+    /** GitHub OAuth App client secret. */
+    clientSecret: string;
+    /** OAuth callback URL (your server's callback endpoint). */
+    redirectUri: string;
+    /** GitHub OAuth scopes. Default: [] */
+    scopes?: string[];
+    /** Session key for user data. Default: "user" */
+    sessionKey?: string;
+    /** Message shown to the user. Default: "Please sign in with GitHub to continue." */
+    message?: string;
+    /** Timeout in ms. Default: 300000 */
+    timeout?: number;
+    /** Custom skip condition. Takes priority over sessionKey check. */
+    skipIf?: (c: ToolContext) => boolean | Promise<boolean>;
+    /** Called after authentication completes successfully, before next(). */
+    onComplete?: (c: ToolContext) => void | Promise<void>;
+}
+/** @deprecated Use `GitHubOptions` instead. */
+type GitHubOAuthOptions = GitHubOptions;
+declare function github(options: GitHubOptions): ToolMiddleware;
+/** @deprecated Use `github()` from `@lynq/github` instead. */
+declare const githubOAuth: typeof github;
+interface HandleCallbackOptions {
+    clientId: string;
+    clientSecret: string;
+    /** Session key for user data. Default: "user" */
+    sessionKey?: string;
+}
+/** @deprecated Use `HandleCallbackOptions` instead. */
+type HandleGitHubCallbackOptions = HandleCallbackOptions;
+/**
+ * Handle GitHub OAuth callback. Call from your HTTP callback route.
+ * Exchanges code for token, fetches user info, stores in session, and completes elicitation.
+ */
+declare function handleCallback(server: MCPServer, params: {
+    code: string;
+    state: string;
+}, options: HandleCallbackOptions): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/** @deprecated Use `handleCallback()` from `@lynq/github` instead. */
+declare const handleGitHubCallback: typeof handleCallback;
+
+export { type GitHubOAuthOptions, type GitHubOptions, type HandleCallbackOptions, type HandleGitHubCallbackOptions, github, githubOAuth, handleCallback, handleGitHubCallback };

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import {verifyState,signState}from'@lynq/lynq/helpers';import {oauth}from'@lynq/lynq/oauth';function m(e){let s=e.scopes??[],t={name:e.name??"github",sessionKey:e.sessionKey??"user",message:e.message??"Please sign in with GitHub to continue.",buildUrl({sessionId:c,elicitationId:i}){let n=new URLSearchParams({client_id:e.clientId,redirect_uri:e.redirectUri,state:signState(c,i,e.clientSecret)});return s.length>0&&n.set("scope",s.join(" ")),`https://github.com/login/oauth/authorize?${n}`}};return e.timeout!==void 0&&(t.timeout=e.timeout),e.skipIf&&(t.skipIf=e.skipIf),e.onComplete&&(t.onComplete=e.onComplete),oauth(t)}var y=m;async function f(e,s,t){let c=t.sessionKey??"user",i=verifyState(s.state,t.clientSecret);if(!i)return {success:false,error:"Invalid state parameter"};let{sessionId:n,elicitationId:l}=i;try{let r=await(await fetch("https://github.com/login/oauth/access_token",{method:"POST",headers:{"Content-Type":"application/json",Accept:"application/json"},body:JSON.stringify({client_id:t.clientId,client_secret:t.clientSecret,code:s.code})})).json();if(!r.access_token)return {success:!1,error:r.error_description??r.error??"Token exchange failed"};let u=await(await fetch("https://api.github.com/user",{headers:{Authorization:`Bearer ${r.access_token}`}})).json(),a=e.session(n);return a.set(c,u),a.set("accessToken",r.access_token),e.completeElicitation(l),{success:!0}}catch(o){return {success:false,error:o instanceof Error?o.message:String(o)}}}var C=f;
+export{m as github,y as githubOAuth,f as handleCallback,C as handleGitHubCallback};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@lynq/github",
+  "version": "0.1.0",
+  "description": "GitHub OAuth provider for lynq MCP framework.",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@lynq/lynq": "^0.8.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.0.0",
+    "zod": "^3.24.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hogekai/lynq",
+    "directory": "packages/github"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}