add oauth apis and bump to version 0.1.1

Author: Prashant-Surya

README.md

@@ -1,4 +1,4 @@
-## @makeplane/plane-node-sdk@0.1.0
+## @makeplane/plane-node-sdk@0.1.1
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @makeplane/[email protected].0 --save
+npm install @makeplane/[email protected].1 --save
 ```
 
 _unPublished (not recommended):_

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@makeplane/plane-node-sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Node SDK for Plane",
   "author": "Plane <[email protected]>",
   "repository": {

package.json

@@ -3,3 +3,4 @@
 export * from './runtime';
 export * from './apis/index';
 export * from './models/index';
+export * from "./oauth/api";

src/index.ts

@@ -0,0 +1,176 @@
+import * as runtime from "../runtime";
+import { PlaneOAuthTokenResponse, PlaneOAuthAppInstallation } from "./models";
+
+/**
+ * OAuth API helper class
+ */
+export class OAuthApi extends runtime.BaseAPI {
+  private clientId: string;
+  private clientSecret: string;
+  private redirectUri: string;
+  private baseUrl: string;
+
+  constructor(
+    configuration: runtime.Configuration,
+    oauthConfig: {
+      clientId: string;
+      clientSecret: string;
+      redirectUri: string;
+    }
+  ) {
+    super(configuration);
+    this.clientId = oauthConfig.clientId;
+    this.clientSecret = oauthConfig.clientSecret;
+    this.redirectUri = oauthConfig.redirectUri;
+    this.baseUrl = configuration.basePath || "https://api.plane.so";
+  }
+
+  /**
+   * Get the authorization URL for the OAuth flow
+   * @param responseType - The response type (default: "code")
+   * @param state - Optional state parameter for security
+   * @returns The authorization URL
+   */
+  getAuthorizationUrl(responseType: string = "code", state?: string): string {
+    const params = new URLSearchParams({
+      client_id: this.clientId,
+      response_type: responseType,
+      redirect_uri: this.redirectUri,
+    });
+
+    if (state) {
+      params.append("state", state);
+    }
+
+    return `${this.baseUrl}/auth/o/authorize-app/?${params.toString()}`;
+  }
+
+  /**
+   * Exchange authorization code for access token
+   * @param code - The authorization code
+   * @param grantType - The grant type (default: "authorization_code")
+   * @returns Promise resolving to token response
+   */
+  async exchangeCodeForToken(
+    code: string,
+    grantType: string = "authorization_code"
+  ): Promise<PlaneOAuthTokenResponse> {
+    const data = new URLSearchParams({
+      grant_type: grantType,
+      code: code,
+      client_id: this.clientId,
+      client_secret: this.clientSecret,
+      redirect_uri: this.redirectUri,
+    });
+
+    const headers: runtime.HTTPHeaders = {
+      "Cache-Control": "no-cache",
+      "Content-Type": "application/x-www-form-urlencoded",
+    };
+
+    const response = await this.request({
+      path: `/auth/o/token/`,
+      method: "POST",
+      headers: headers,
+      body: data,
+    });
+
+    return await response.json();
+  }
+
+  /**
+   * Get a new access token using a refresh token
+   * @param refreshToken - The refresh token
+   * @returns Promise resolving to token response
+   */
+  async getRefreshToken(
+    refreshToken: string
+  ): Promise<PlaneOAuthTokenResponse> {
+    const data = new URLSearchParams({
+      grant_type: "refresh_token",
+      refresh_token: refreshToken,
+      client_id: this.clientId,
+      client_secret: this.clientSecret,
+    });
+
+    const headers: runtime.HTTPHeaders = {
+      "Cache-Control": "no-cache",
+      "Content-Type": "application/x-www-form-urlencoded",
+    };
+
+    const response = await this.request({
+      path: `/auth/o/token/`,
+      method: "POST",
+      headers: headers,
+      body: data,
+    });
+
+    return await response.json();
+  }
+
+  /**
+   * Get a new access token using client credentials for bot/app installations
+   * @param appInstallationId - The app installation ID
+   * @returns Promise resolving to token response
+   */
+  async getBotToken(
+    appInstallationId: string
+  ): Promise<PlaneOAuthTokenResponse> {
+    const data = new URLSearchParams({
+      grant_type: "client_credentials",
+      app_installation_id: appInstallationId,
+    });
+
+    const headers: runtime.HTTPHeaders = {
+      "Cache-Control": "no-cache",
+      "Content-Type": "application/x-www-form-urlencoded",
+      Authorization: `Basic ${this.getBasicAuthToken()}`,
+    };
+
+    const response = await this.request({
+      path: `/auth/o/token/`,
+      method: "POST",
+      headers: headers,
+      body: data,
+    });
+
+    return await response.json();
+  }
+
+  /**
+   * Get an app installation by ID using the bot token
+   * @param token - The bot token from getBotToken method
+   * @param appInstallationId - The app installation ID
+   * @returns Promise resolving to app installation
+   */
+  async getAppInstallation(
+    token: string,
+    appInstallationId: string
+  ): Promise<PlaneOAuthAppInstallation> {
+    const headers: runtime.HTTPHeaders = {
+      Authorization: `Bearer ${token}`,
+    };
+
+    const response = await this.request({
+      path: `/auth/o/app-installation/?id=${appInstallationId}`,
+      method: "GET",
+      headers: headers,
+    });
+
+    const data = await response.json();
+    if (!data || data.length === 0) {
+      throw new runtime.ResponseError(response, "App installation not found");
+    }
+
+    return data[0];
+  }
+
+  /**
+   * Generate basic auth token from client_id and client_secret
+   * @returns Base64 encoded basic auth token
+   */
+  private getBasicAuthToken(): string {
+    const credentials = `${this.clientId}:${this.clientSecret}`;
+    return btoa(credentials);
+  }
+}

src/oauth/api.ts

@@ -0,0 +1,30 @@
+export interface PlaneOAuthTokenResponse {
+  access_token: string;
+  expires_in?: number;
+  token_type: string;
+  scope?: string;
+  refresh_token?: string;
+}
+
+export interface WorkspaceDetail {
+  name: string;
+  slug: string;
+  id: string;
+  logo_url?: string;
+}
+
+export interface PlaneOAuthAppInstallation {
+  id: string;
+  workspace_detail: WorkspaceDetail;
+  created_at: string;
+  updated_at: string;
+  deleted_at?: string;
+  status: string;
+  created_by?: string;
+  updated_by?: string;
+  workspace: string;
+  application: string;
+  installed_by: string;
+  app_bot: string;
+  webhook?: string;
+}