fix: response type definitions for APIs

- WorkItemTypes Response
- GetProjectMembers Response
- IssueSearch Response
- State Response (without slug)

make appInstallationId optional in getAppInstallations endpoint

bump version to 0.1.2

Author: Prashant-Surya

.openapi-generator/FILES

@@ -1,6 +1,7 @@
 .gitignore
 .npmignore
 README.md
+eslint.config.mjs
 package.json
 src/apis/AssetsApi.ts
 src/apis/CyclesApi.ts
@@ -52,6 +53,7 @@ src/models/IssuePropertyValueAPI.ts
 src/models/IssuePropertyValueAPIRequest.ts
 src/models/IssueRequest.ts
 src/models/IssueSearch.ts
+src/models/IssueSearchItem.ts
 src/models/IssueTypeAPI.ts
 src/models/IssueTypeAPIRequest.ts
 src/models/IssueWorkLogAPI.ts
@@ -115,5 +117,7 @@ src/models/TypeEnum.ts
 src/models/UserAssetUploadRequest.ts
 src/models/UserLite.ts
 src/models/index.ts
+src/oauth/api.ts
+src/oauth/models.ts
 src/runtime.ts
 tsconfig.json

README.md

@@ -1,4 +1,4 @@
-## @makeplane/plane-node-sdk@0.1.1
+## @makeplane/plane-node-sdk@0.1.2
 
 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].1 --save
+npm install @makeplane/[email protected].2 --save
 ```
 
 _unPublished (not recommended):_

package-lock.json

@@ -1,12 +1,15 @@
 {
   "name": "@makeplane/plane-node-sdk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Node SDK for Plane",
   "author": "Plane <[email protected]>",
   "repository": {
     "type": "git",
     "url": "https://github.com/makeplane/plane-node-sdk.git"
   },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
   "scripts": {

package.json

@@ -42,7 +42,7 @@ export class MembersApi extends runtime.BaseAPI {
      * Retrieve all users who are members of the specified project.
      * List project members
      */
-    async getProjectMembersRaw(requestParameters: GetProjectMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserLite>> {
+    async getProjectMembersRaw(requestParameters: GetProjectMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<UserLite>>> {
         if (requestParameters['projectId'] == null) {
             throw new runtime.RequiredError(
                 'projectId',
@@ -82,14 +82,14 @@ export class MembersApi extends runtime.BaseAPI {
             query: queryParameters,
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => UserLiteFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(UserLiteFromJSON));
     }
 
     /**
      * Retrieve all users who are members of the specified project.
      * List project members
      */
-    async getProjectMembers(requestParameters: GetProjectMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserLite> {
+    async getProjectMembers(requestParameters: GetProjectMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<UserLite>> {
         const response = await this.getProjectMembersRaw(requestParameters, initOverrides);
         return await response.value();
     }

src/apis/MembersApi.ts

@@ -194,7 +194,7 @@ export class WorkItemTypesApi extends runtime.BaseAPI {
      * List all issue types for a project
      * List issue types
      */
-    async listIssueTypesRaw(requestParameters: ListIssueTypesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IssueTypeAPI>> {
+    async listIssueTypesRaw(requestParameters: ListIssueTypesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IssueTypeAPI>>> {
         if (requestParameters['projectId'] == null) {
             throw new runtime.RequiredError(
                 'projectId',
@@ -234,14 +234,14 @@ export class WorkItemTypesApi extends runtime.BaseAPI {
             query: queryParameters,
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => IssueTypeAPIFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(IssueTypeAPIFromJSON));
     }
 
     /**
      * List all issue types for a project
      * List issue types
      */
-    async listIssueTypes(requestParameters: ListIssueTypesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IssueTypeAPI> {
+    async listIssueTypes(requestParameters: ListIssueTypesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IssueTypeAPI>> {
         const response = await this.listIssueTypesRaw(requestParameters, initOverrides);
         return await response.value();
     }

src/apis/WorkItemTypesApi.ts

@@ -12,6 +12,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { IssueSearchItem } from './IssueSearchItem';
+import {
+    IssueSearchItemFromJSON,
+    IssueSearchItemFromJSONTyped,
+    IssueSearchItemToJSON,
+    IssueSearchItemToJSONTyped,
+} from './IssueSearchItem';
+
 /**
  * Serializer for work item search result data formatting.
  * 
@@ -22,53 +30,18 @@ import { mapValues } from '../runtime';
  */
 export interface IssueSearch {
     /**
-     * Issue ID
-     * @type {string}
-     * @memberof IssueSearch
-     */
-    id: string;
-    /**
-     * Issue name
-     * @type {string}
-     * @memberof IssueSearch
-     */
-    name: string;
-    /**
-     * Issue sequence ID
-     * @type {string}
-     * @memberof IssueSearch
-     */
-    sequenceId: string;
-    /**
-     * Project identifier
-     * @type {string}
-     * @memberof IssueSearch
-     */
-    projectIdentifier: string;
-    /**
-     * Project ID
-     * @type {string}
-     * @memberof IssueSearch
-     */
-    projectId: string;
-    /**
-     * Workspace slug
-     * @type {string}
+     * Array of search result issues
+     * @type {Array<IssueSearchItem>}
      * @memberof IssueSearch
      */
-    workspaceSlug: string;
+    issues: Array<IssueSearchItem>;
 }
 
 /**
  * Check if a given object implements the IssueSearch interface.
  */
 export function instanceOfIssueSearch(value: object): value is IssueSearch {
-    if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('name' in value) || value['name'] === undefined) return false;
-    if (!('sequenceId' in value) || value['sequenceId'] === undefined) return false;
-    if (!('projectIdentifier' in value) || value['projectIdentifier'] === undefined) return false;
-    if (!('projectId' in value) || value['projectId'] === undefined) return false;
-    if (!('workspaceSlug' in value) || value['workspaceSlug'] === undefined) return false;
+    if (!('issues' in value) || value['issues'] === undefined) return false;
     return true;
 }
 
@@ -82,12 +55,7 @@ export function IssueSearchFromJSONTyped(json: any, ignoreDiscriminator: boolean
     }
     return {
 
-        'id': json['id'],
-        'name': json['name'],
-        'sequenceId': json['sequence_id'],
-        'projectIdentifier': json['project__identifier'],
-        'projectId': json['project_id'],
-        'workspaceSlug': json['workspace__slug'],
+        'issues': ((json['issues'] as Array<any>).map(IssueSearchItemFromJSON)),
     };
 }
 
@@ -102,12 +70,7 @@ export function IssueSearchToJSONTyped(value?: IssueSearch | null, ignoreDiscrim
 
     return {
 
-        'id': value['id'],
-        'name': value['name'],
-        'sequence_id': value['sequenceId'],
-        'project__identifier': value['projectIdentifier'],
-        'project_id': value['projectId'],
-        'workspace__slug': value['workspaceSlug'],
+        'issues': ((value['issues'] as Array<any>).map(IssueSearchItemToJSON)),
     };
 }
 

src/models/IssueSearch.ts

@@ -0,0 +1,113 @@
+/* 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.1
+ * Contact: [email protected]
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Individual issue component for search results.
+ * 
+ * Provides standardized search result structure including work item identifiers,
+ * project context, and workspace information for search API responses.
+ * @export
+ * @interface IssueSearchItem
+ */
+export interface IssueSearchItem {
+    /**
+     * Issue ID
+     * @type {string}
+     * @memberof IssueSearchItem
+     */
+    id: string;
+    /**
+     * Issue name
+     * @type {string}
+     * @memberof IssueSearchItem
+     */
+    name: string;
+    /**
+     * Issue sequence ID
+     * @type {string}
+     * @memberof IssueSearchItem
+     */
+    sequenceId: string;
+    /**
+     * Project identifier
+     * @type {string}
+     * @memberof IssueSearchItem
+     */
+    projectIdentifier: string;
+    /**
+     * Project ID
+     * @type {string}
+     * @memberof IssueSearchItem
+     */
+    projectId: string;
+    /**
+     * Workspace slug
+     * @type {string}
+     * @memberof IssueSearchItem
+     */
+    workspaceSlug: string;
+}
+
+/**
+ * Check if a given object implements the IssueSearchItem interface.
+ */
+export function instanceOfIssueSearchItem(value: object): value is IssueSearchItem {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('sequenceId' in value) || value['sequenceId'] === undefined) return false;
+    if (!('projectIdentifier' in value) || value['projectIdentifier'] === undefined) return false;
+    if (!('projectId' in value) || value['projectId'] === undefined) return false;
+    if (!('workspaceSlug' in value) || value['workspaceSlug'] === undefined) return false;
+    return true;
+}
+
+export function IssueSearchItemFromJSON(json: any): IssueSearchItem {
+    return IssueSearchItemFromJSONTyped(json, false);
+}
+
+export function IssueSearchItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueSearchItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'sequenceId': json['sequence_id'],
+        'projectIdentifier': json['project__identifier'],
+        'projectId': json['project_id'],
+        'workspaceSlug': json['workspace__slug'],
+    };
+}
+
+export function IssueSearchItemToJSON(json: any): IssueSearchItem {
+    return IssueSearchItemToJSONTyped(json, false);
+}
+
+export function IssueSearchItemToJSONTyped(value?: IssueSearchItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'sequence_id': value['sequenceId'],
+        'project__identifier': value['projectIdentifier'],
+        'project_id': value['projectId'],
+        'workspace__slug': value['workspaceSlug'],
+    };
+}
+

src/models/IssueSearchItem.ts

@@ -71,12 +71,6 @@ export interface State {
      * @memberof State
      */
     color: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof State
-     */
-    readonly slug?: string;
     /**
      * 
      * @type {number}
@@ -167,7 +161,6 @@ export function StateFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sta
         'name': json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'color': json['color'],
-        'slug': json['slug'] == null ? undefined : json['slug'],
         'sequence': json['sequence'] == null ? undefined : json['sequence'],
         'group': json['group'] == null ? undefined : GroupEnumFromJSON(json['group']),
         'isTriage': json['is_triage'] == null ? undefined : json['is_triage'],
@@ -185,7 +178,7 @@ export function StateToJSON(json: any): State {
     return StateToJSONTyped(json, false);
 }
 
-export function StateToJSONTyped(value?: Omit<State, 'id'|'created_at'|'updated_at'|'deleted_at'|'slug'|'created_by'|'updated_by'|'project'|'workspace'> | null, ignoreDiscriminator: boolean = false): any {
+export function StateToJSONTyped(value?: Omit<State, 'id'|'created_at'|'updated_at'|'deleted_at'|'created_by'|'updated_by'|'project'|'workspace'> | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }

src/models/State.ts

@@ -31,6 +31,7 @@ export * from './IssuePropertyValueAPI';
 export * from './IssuePropertyValueAPIRequest';
 export * from './IssueRequest';
 export * from './IssueSearch';
+export * from './IssueSearchItem';
 export * from './IssueTypeAPI';
 export * from './IssueTypeAPIRequest';
 export * from './IssueWorkLogAPI';