@makeplane/plane-node-sdk 0.1.0

package/.github/workflows/publish-node-sdk.yml

@@ -0,0 +1,24 @@
+name: Publish Node SDK to npm
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies and build
+        run: npm ci
+
+      - name: Publish to npm
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.openapi-generator/FILES

@@ -0,0 +1,119 @@
+.gitignore
+.npmignore
+README.md
+package.json
+src/apis/AssetsApi.ts
+src/apis/CyclesApi.ts
+src/apis/IntakeApi.ts
+src/apis/LabelsApi.ts
+src/apis/MembersApi.ts
+src/apis/ModulesApi.ts
+src/apis/ProjectsApi.ts
+src/apis/StatesApi.ts
+src/apis/UsersApi.ts
+src/apis/WorkItemActivityApi.ts
+src/apis/WorkItemAttachmentsApi.ts
+src/apis/WorkItemCommentsApi.ts
+src/apis/WorkItemLinksApi.ts
+src/apis/WorkItemPropertiesApi.ts
+src/apis/WorkItemTypesApi.ts
+src/apis/WorkItemWorklogsApi.ts
+src/apis/WorkItemsApi.ts
+src/apis/index.ts
+src/index.ts
+src/models/AccessEnum.ts
+src/models/Cycle.ts
+src/models/CycleCreateRequest.ts
+src/models/CycleIssue.ts
+src/models/CycleIssueRequestRequest.ts
+src/models/CycleLite.ts
+src/models/EntityTypeEnum.ts
+src/models/GenericAssetUploadRequest.ts
+src/models/GetWorkspaceMembers200ResponseInner.ts
+src/models/GroupEnum.ts
+src/models/IntakeIssue.ts
+src/models/IntakeIssueCreateRequest.ts
+src/models/IntakeWorkItemStatusEnum.ts
+src/models/Issue.ts
+src/models/IssueActivity.ts
+src/models/IssueAttachment.ts
+src/models/IssueAttachmentUploadRequest.ts
+src/models/IssueComment.ts
+src/models/IssueCommentCreateRequest.ts
+src/models/IssueExpand.ts
+src/models/IssueForIntakeRequest.ts
+src/models/IssueLink.ts
+src/models/IssueLinkCreateRequest.ts
+src/models/IssuePropertyAPI.ts
+src/models/IssuePropertyAPIRequest.ts
+src/models/IssuePropertyOptionAPI.ts
+src/models/IssuePropertyOptionAPIRequest.ts
+src/models/IssuePropertyValueAPI.ts
+src/models/IssuePropertyValueAPIRequest.ts
+src/models/IssueRequest.ts
+src/models/IssueSearch.ts
+src/models/IssueTypeAPI.ts
+src/models/IssueTypeAPIRequest.ts
+src/models/IssueWorkLogAPI.ts
+src/models/IssueWorkLogAPIRequest.ts
+src/models/Label.ts
+src/models/LabelCreateUpdateRequest.ts
+src/models/LabelLite.ts
+src/models/Module.ts
+src/models/ModuleCreateRequest.ts
+src/models/ModuleIssue.ts
+src/models/ModuleIssueRequestRequest.ts
+src/models/ModuleLite.ts
+src/models/ModuleStatusEnum.ts
+src/models/NetworkEnum.ts
+src/models/PaginatedArchivedCycleResponse.ts
+src/models/PaginatedArchivedModuleResponse.ts
+src/models/PaginatedCycleIssueResponse.ts
+src/models/PaginatedCycleResponse.ts
+src/models/PaginatedIntakeIssueResponse.ts
+src/models/PaginatedIssueActivityDetailResponse.ts
+src/models/PaginatedIssueActivityResponse.ts
+src/models/PaginatedIssueCommentResponse.ts
+src/models/PaginatedIssueLinkDetailResponse.ts
+src/models/PaginatedIssueLinkResponse.ts
+src/models/PaginatedLabelResponse.ts
+src/models/PaginatedModuleIssueResponse.ts
+src/models/PaginatedModuleResponse.ts
+src/models/PaginatedProjectResponse.ts
+src/models/PaginatedStateResponse.ts
+src/models/PaginatedWorkItemResponse.ts
+src/models/PatchedAssetUpdateRequest.ts
+src/models/PatchedCycleUpdateRequest.ts
+src/models/PatchedGenericAssetUpdateRequest.ts
+src/models/PatchedIntakeIssueUpdateRequest.ts
+src/models/PatchedIssueCommentCreateRequest.ts
+src/models/PatchedIssueLinkUpdateRequest.ts
+src/models/PatchedIssuePropertyAPIRequest.ts
+src/models/PatchedIssuePropertyOptionAPIRequest.ts
+src/models/PatchedIssueRequest.ts
+src/models/PatchedIssueTypeAPIRequest.ts
+src/models/PatchedIssueWorkLogAPIRequest.ts
+src/models/PatchedLabelCreateUpdateRequest.ts
+src/models/PatchedModuleUpdateRequest.ts
+src/models/PatchedProjectUpdateRequest.ts
+src/models/PatchedStateRequest.ts
+src/models/PriorityEnum.ts
+src/models/Project.ts
+src/models/ProjectCreateRequest.ts
+src/models/ProjectWorklogSummary.ts
+src/models/PropertyTypeEnum.ts
+src/models/RelationTypeEnum.ts
+src/models/RetrieveWorkItemAttachment400Response.ts
+src/models/State.ts
+src/models/StateLite.ts
+src/models/StateRequest.ts
+src/models/TimezoneEnum.ts
+src/models/TransferCycleIssueRequestRequest.ts
+src/models/TransferCycleWorkItems200Response.ts
+src/models/TransferCycleWorkItems400Response.ts
+src/models/TypeEnum.ts
+src/models/UserAssetUploadRequest.ts
+src/models/UserLite.ts
+src/models/index.ts
+src/runtime.ts
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.13.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/README.md

@@ -0,0 +1,95 @@
+## @makeplane/plane-node-sdk@0.1.0
+
+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:
+
+Environment
+* Node.js
+* Webpack
+* Browserify
+
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run `npm publish`
+
+### Consuming
+
+navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install @makeplane/plane-node-sdk@0.1.0 --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save
+```
+
+### Example Usage
+```ts
+import {
+  Configuration,
+  ProjectsApi,
+  UsersApi,
+} from "@makeplane/plane-node-sdk";
+
+async function testPlaneSDK() {
+  console.log("🚀 Testing Plane Node SDK...\n");
+
+  try {
+    // Create configuration using API Key Authentication
+    const config = new Configuration({
+      apiKey: "<PLANE_API_KEY>",
+    });
+
+    // Create configuration using OAuth Client Credentials Authentication
+    // const config = new Configuration({
+    //   accessToken: "<PLANE_ACCESS_TOKEN>",
+    // });
+
+    console.log("✅ Configuration created successfully");
+    console.log(`Base URL: ${config.basePath}\n`);
+
+    // Initialize APIs
+    const projectsApi = new ProjectsApi(config);
+    const usersApi = new UsersApi(config);
+
+    console.log("✅ APIs initialized successfully\n");
+
+    const user = await usersApi.getCurrentUser();
+    console.log(user);
+
+    const projectsResponse = await projectsApi.listProjects({
+      slug: "<workspace-slug>",
+    });
+    for (const project of projectsResponse.results) {
+      console.log(`${project.id} - ${project.name}`);
+    }
+  } catch (error) {
+    console.error("❌ Error initializing SDK:", error);
+  }
+}
+
+// Run the test
+testPlaneSDK().catch(console.error);
+```

package/dist/apis/AssetsApi.d.ts

@@ -0,0 +1,100 @@
+/**
+ * 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: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { GenericAssetUploadRequest, PatchedAssetUpdateRequest, PatchedGenericAssetUpdateRequest, UserAssetUploadRequest } from '../models/index';
+export interface CreateGenericAssetUploadRequest {
+    slug: string;
+    genericAssetUploadRequest: GenericAssetUploadRequest;
+}
+export interface CreateUserAssetUploadRequest {
+    userAssetUploadRequest: UserAssetUploadRequest;
+}
+export interface DeleteUserAssetRequest {
+    assetId: string;
+}
+export interface GetGenericAssetRequest {
+    assetId: string;
+    slug: string;
+}
+export interface UpdateGenericAssetRequest {
+    assetId: string;
+    slug: string;
+    patchedGenericAssetUpdateRequest?: PatchedGenericAssetUpdateRequest;
+}
+export interface UpdateUserAssetRequest {
+    assetId: string;
+    patchedAssetUpdateRequest?: PatchedAssetUpdateRequest;
+}
+/**
+ *
+ */
+export declare class AssetsApi extends runtime.BaseAPI {
+    /**
+     * Generate presigned URL for generic asset upload
+     * Generate presigned URL for generic asset upload
+     */
+    createGenericAssetUploadRaw(requestParameters: CreateGenericAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Generate presigned URL for generic asset upload
+     * Generate presigned URL for generic asset upload
+     */
+    createGenericAssetUpload(requestParameters: CreateGenericAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Generate presigned URL for user asset upload
+     * Generate presigned URL for user asset upload
+     */
+    createUserAssetUploadRaw(requestParameters: CreateUserAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Generate presigned URL for user asset upload
+     * Generate presigned URL for user asset upload
+     */
+    createUserAssetUpload(requestParameters: CreateUserAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Delete user asset.  Delete a user profile asset (avatar or cover image) and remove its reference from the user profile. This performs a soft delete by marking the asset as deleted and updating the user\'s profile.
+     * Delete user asset
+     */
+    deleteUserAssetRaw(requestParameters: DeleteUserAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete user asset.  Delete a user profile asset (avatar or cover image) and remove its reference from the user profile. This performs a soft delete by marking the asset as deleted and updating the user\'s profile.
+     * Delete user asset
+     */
+    deleteUserAsset(requestParameters: DeleteUserAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get presigned URL for asset download
+     * Get presigned URL for asset download
+     */
+    getGenericAssetRaw(requestParameters: GetGenericAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Get presigned URL for asset download
+     * Get presigned URL for asset download
+     */
+    getGenericAsset(requestParameters: GetGenericAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Update generic asset after upload completion
+     * Update generic asset after upload completion
+     */
+    updateGenericAssetRaw(requestParameters: UpdateGenericAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update generic asset after upload completion
+     * Update generic asset after upload completion
+     */
+    updateGenericAsset(requestParameters: UpdateGenericAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Mark user asset as uploaded
+     * Mark user asset as uploaded
+     */
+    updateUserAssetRaw(requestParameters: UpdateUserAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Mark user asset as uploaded
+     * Mark user asset as uploaded
+     */
+    updateUserAsset(requestParameters: UpdateUserAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}