@makeplane/plane-node-sdk 0.1.5 → 0.2.0

package/src/oauth/api.ts

@@ -1,183 +0,0 @@
-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);
-    if (oauthConfig) {
-      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 getAppInstallations(
-    token: string,
-    appInstallationId?: string
-  ): Promise<PlaneOAuthAppInstallation[]> {
-    const headers: runtime.HTTPHeaders = {
-      Authorization: `Bearer ${token}`,
-    };
-
-    let path = `/auth/o/app-installation/`;
-    if (appInstallationId) {
-      path += `?id=${appInstallationId}`;
-    }
-
-    const response = await this.request({
-      path: path,
-      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;
-  }
-
-  /**
-   * 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);
-  }
-}

package/src/oauth/models.ts

@@ -1,30 +0,0 @@
-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;
-}

package/src/runtime.ts

@@ -1,431 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * The Plane REST API
- * The Plane REST API  Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
- *
- * The version of the API Spec: 0.0.2
- * Contact: support@plane.so
- *
- * NOTE: This class is auto generated.
- * Do not edit the class manually.
- */
-
-
-export const BASE_PATH = "https://api.plane.so".replace(/\/+$/, "");
-
-export interface ConfigurationParameters {
-    basePath?: string; // override base path
-    fetchApi?: FetchAPI; // override for fetch implementation
-    middleware?: Middleware[]; // middleware to apply before/after fetch requests
-    queryParamsStringify?: (params: HTTPQuery) => string; // stringify function for query strings
-    username?: string; // parameter for basic security
-    password?: string; // parameter for basic security
-    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>); // parameter for apiKey security
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>); // parameter for oauth2 security
-    headers?: HTTPHeaders; //header params we want to use on every request
-    credentials?: RequestCredentials; //value for the credentials param we want to use on each request
-}
-
-export class Configuration {
-    constructor(private configuration: ConfigurationParameters = {}) {}
-
-    set config(configuration: Configuration) {
-        this.configuration = configuration;
-    }
-
-    get basePath(): string {
-        return this.configuration.basePath != null ? this.configuration.basePath : BASE_PATH;
-    }
-
-    get fetchApi(): FetchAPI | undefined {
-        return this.configuration.fetchApi;
-    }
-
-    get middleware(): Middleware[] {
-        return this.configuration.middleware || [];
-    }
-
-    get queryParamsStringify(): (params: HTTPQuery) => string {
-        return this.configuration.queryParamsStringify || querystring;
-    }
-
-    get username(): string | undefined {
-        return this.configuration.username;
-    }
-
-    get password(): string | undefined {
-        return this.configuration.password;
-    }
-
-    get apiKey(): ((name: string) => string | Promise<string>) | undefined {
-        const apiKey = this.configuration.apiKey;
-        if (apiKey) {
-            return typeof apiKey === 'function' ? apiKey : () => apiKey;
-        }
-        return undefined;
-    }
-
-    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined {
-        const accessToken = `Bearer ${this.configuration.accessToken}`;
-        if (accessToken) {
-            return typeof accessToken === 'function' ? accessToken : async () => accessToken;
-        }
-        return undefined;
-    }
-
-    get headers(): HTTPHeaders | undefined {
-        return this.configuration.headers;
-    }
-
-    get credentials(): RequestCredentials | undefined {
-        return this.configuration.credentials;
-    }
-}
-
-export const DefaultConfig = new Configuration();
-
-/**
- * This is the base class for all generated API classes.
- */
-export class BaseAPI {
-
-    private static readonly jsonRegex = new RegExp('^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$', 'i');
-    private middleware: Middleware[];
-
-    constructor(protected configuration = DefaultConfig) {
-        this.middleware = configuration.middleware;
-    }
-
-    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]) {
-        const next = this.clone<T>();
-        next.middleware = next.middleware.concat(...middlewares);
-        return next;
-    }
-
-    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>) {
-        const middlewares = preMiddlewares.map((pre) => ({ pre }));
-        return this.withMiddleware<T>(...middlewares);
-    }
-
-    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>) {
-        const middlewares = postMiddlewares.map((post) => ({ post }));
-        return this.withMiddleware<T>(...middlewares);
-    }
-
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    protected isJsonMime(mime: string | null | undefined): boolean {
-        if (!mime) {
-            return false;
-        }
-        return BaseAPI.jsonRegex.test(mime);
-    }
-
-    protected async request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response> {
-        const { url, init } = await this.createFetchParams(context, initOverrides);
-        const response = await this.fetchApi(url, init);
-        if (response && (response.status >= 200 && response.status < 300)) {
-            return response;
-        }
-        throw new ResponseError(response, 'Response returned an error code');
-    }
-
-    private async createFetchParams(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction) {
-        let url = this.configuration.basePath + context.path;
-        if (context.query !== undefined && Object.keys(context.query).length !== 0) {
-            // only add the querystring to the URL if there are query parameters.
-            // this is done to avoid urls ending with a "?" character which buggy webservers
-            // do not handle correctly sometimes.
-            url += '?' + this.configuration.queryParamsStringify(context.query);
-        }
-
-        const headers = Object.assign({}, this.configuration.headers, context.headers);
-        Object.keys(headers).forEach(key => headers[key] === undefined ? delete headers[key] : {});
-
-        const initOverrideFn =
-            typeof initOverrides === "function"
-                ? initOverrides
-                : async () => initOverrides;
-
-        const initParams = {
-            method: context.method,
-            headers,
-            body: context.body,
-            credentials: this.configuration.credentials,
-        };
-
-        const overriddenInit: RequestInit = {
-            ...initParams,
-            ...(await initOverrideFn({
-                init: initParams,
-                context,
-            }))
-        };
-
-        let body: any;
-        if (isFormData(overriddenInit.body)
-            || (overriddenInit.body instanceof URLSearchParams)
-            || isBlob(overriddenInit.body)) {
-          body = overriddenInit.body;
-        } else if (this.isJsonMime(headers['Content-Type'])) {
-          body = JSON.stringify(overriddenInit.body);
-        } else {
-          body = overriddenInit.body;
-        }
-
-        const init: RequestInit = {
-            ...overriddenInit,
-            body
-        };
-
-        return { url, init };
-    }
-
-    private fetchApi = async (url: string, init: RequestInit) => {
-        let fetchParams = { url, init };
-        for (const middleware of this.middleware) {
-            if (middleware.pre) {
-                fetchParams = await middleware.pre({
-                    fetch: this.fetchApi,
-                    ...fetchParams,
-                }) || fetchParams;
-            }
-        }
-        let response: Response | undefined = undefined;
-        try {
-            response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
-        } catch (e) {
-            for (const middleware of this.middleware) {
-                if (middleware.onError) {
-                    response = await middleware.onError({
-                        fetch: this.fetchApi,
-                        url: fetchParams.url,
-                        init: fetchParams.init,
-                        error: e,
-                        response: response ? response.clone() : undefined,
-                    }) || response;
-                }
-            }
-            if (response === undefined) {
-              if (e instanceof Error) {
-                throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
-              } else {
-                throw e;
-              }
-            }
-        }
-        for (const middleware of this.middleware) {
-            if (middleware.post) {
-                response = await middleware.post({
-                    fetch: this.fetchApi,
-                    url: fetchParams.url,
-                    init: fetchParams.init,
-                    response: response.clone(),
-                }) || response;
-            }
-        }
-        return response;
-    }
-
-    /**
-     * Create a shallow clone of `this` by constructing a new instance
-     * and then shallow cloning data members.
-     */
-    private clone<T extends BaseAPI>(this: T): T {
-        const constructor = this.constructor as any;
-        const next = new constructor(this.configuration);
-        next.middleware = this.middleware.slice();
-        return next;
-    }
-};
-
-function isBlob(value: any): value is Blob {
-    return typeof Blob !== 'undefined' && value instanceof Blob;
-}
-
-function isFormData(value: any): value is FormData {
-    return typeof FormData !== "undefined" && value instanceof FormData;
-}
-
-export class ResponseError extends Error {
-    override name: "ResponseError" = "ResponseError";
-    constructor(public response: Response, msg?: string) {
-        super(msg);
-    }
-}
-
-export class FetchError extends Error {
-    override name: "FetchError" = "FetchError";
-    constructor(public cause: Error, msg?: string) {
-        super(msg);
-    }
-}
-
-export class RequiredError extends Error {
-    override name: "RequiredError" = "RequiredError";
-    constructor(public field: string, msg?: string) {
-        super(msg);
-    }
-}
-
-export const COLLECTION_FORMATS = {
-    csv: ",",
-    ssv: " ",
-    tsv: "\t",
-    pipes: "|",
-};
-
-export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
-
-export type Json = any;
-export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
-export type HTTPHeaders = { [key: string]: string };
-export type HTTPQuery = { [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery };
-export type HTTPBody = Json | FormData | URLSearchParams;
-export type HTTPRequestInit = { headers?: HTTPHeaders; method: HTTPMethod; credentials?: RequestCredentials; body?: HTTPBody };
-export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
-
-export type InitOverrideFunction = (requestContext: { init: HTTPRequestInit, context: RequestOpts }) => Promise<RequestInit>
-
-export interface FetchParams {
-    url: string;
-    init: RequestInit;
-}
-
-export interface RequestOpts {
-    path: string;
-    method: HTTPMethod;
-    headers: HTTPHeaders;
-    query?: HTTPQuery;
-    body?: HTTPBody;
-}
-
-export function querystring(params: HTTPQuery, prefix: string = ''): string {
-    return Object.keys(params)
-        .map(key => querystringSingleKey(key, params[key], prefix))
-        .filter(part => part.length > 0)
-        .join('&');
-}
-
-function querystringSingleKey(key: string, value: string | number | null | undefined | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery, keyPrefix: string = ''): string {
-    const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
-    if (value instanceof Array) {
-        const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
-            .join(`&${encodeURIComponent(fullKey)}=`);
-        return `${encodeURIComponent(fullKey)}=${multiValue}`;
-    }
-    if (value instanceof Set) {
-        const valueAsArray = Array.from(value);
-        return querystringSingleKey(key, valueAsArray, keyPrefix);
-    }
-    if (value instanceof Date) {
-        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
-    }
-    if (value instanceof Object) {
-        return querystring(value as HTTPQuery, fullKey);
-    }
-    return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
-}
-
-export function exists(json: any, key: string) {
-    const value = json[key];
-    return value !== null && value !== undefined;
-}
-
-export function mapValues(data: any, fn: (item: any) => any) {
-    const result: { [key: string]: any } = {};
-    for (const key of Object.keys(data)) {
-        result[key] = fn(data[key]);
-    }
-    return result;
-}
-
-export function canConsumeForm(consumes: Consume[]): boolean {
-    for (const consume of consumes) {
-        if ('multipart/form-data' === consume.contentType) {
-            return true;
-        }
-    }
-    return false;
-}
-
-export interface Consume {
-    contentType: string;
-}
-
-export interface RequestContext {
-    fetch: FetchAPI;
-    url: string;
-    init: RequestInit;
-}
-
-export interface ResponseContext {
-    fetch: FetchAPI;
-    url: string;
-    init: RequestInit;
-    response: Response;
-}
-
-export interface ErrorContext {
-    fetch: FetchAPI;
-    url: string;
-    init: RequestInit;
-    error: unknown;
-    response?: Response;
-}
-
-export interface Middleware {
-    pre?(context: RequestContext): Promise<FetchParams | void>;
-    post?(context: ResponseContext): Promise<Response | void>;
-    onError?(context: ErrorContext): Promise<Response | void>;
-}
-
-export interface ApiResponse<T> {
-    raw: Response;
-    value(): Promise<T>;
-}
-
-export interface ResponseTransformer<T> {
-    (json: any): T;
-}
-
-export class JSONApiResponse<T> {
-    constructor(public raw: Response, private transformer: ResponseTransformer<T> = (jsonValue: any) => jsonValue) {}
-
-    async value(): Promise<T> {
-        return this.transformer(await this.raw.json());
-    }
-}
-
-export class VoidApiResponse {
-    constructor(public raw: Response) {}
-
-    async value(): Promise<void> {
-        return undefined;
-    }
-}
-
-export class BlobApiResponse {
-    constructor(public raw: Response) {}
-
-    async value(): Promise<Blob> {
-        return await this.raw.blob();
-    };
-}
-
-export class TextApiResponse {
-    constructor(public raw: Response) {}
-
-    async value(): Promise<string> {
-        return await this.raw.text();
-    };
-}

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-    "declaration": true,
-    "target": "es5",
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "outDir": "dist",
-    "lib": [
-      "es6",
-      "dom"
-    ],
-    "typeRoots": [
-      "node_modules/@types"
-    ]
-  },
-  "exclude": [
-    "dist",
-    "node_modules"
-  ]
-}