{"id":30759777,"url":"https://github.com/makeplane/plane-node-sdk","last_synced_at":"2026-01-20T17:53:43.079Z","repository":{"id":306194468,"uuid":"992059512","full_name":"makeplane/plane-node-sdk","owner":"makeplane","description":"Typescript SDK for plane.so","archived":false,"fork":false,"pushed_at":"2025-08-05T12:00:15.000Z","size":312,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-05T12:05:46.299Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/makeplane.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-28T14:55:17.000Z","updated_at":"2025-08-05T12:00:14.000Z","dependencies_parsed_at":"2025-07-24T08:52:02.146Z","dependency_job_id":null,"html_url":"https://github.com/makeplane/plane-node-sdk","commit_stats":null,"previous_names":["makeplane/plane-node-sdk"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/makeplane/plane-node-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makeplane%2Fplane-node-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makeplane%2Fplane-node-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makeplane%2Fplane-node-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makeplane%2Fplane-node-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/makeplane","download_url":"https://codeload.github.com/makeplane/plane-node-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makeplane%2Fplane-node-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273612488,"owners_count":25136980,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-04T02:00:08.968Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-04T12:55:26.517Z","updated_at":"2025-12-24T16:52:28.210Z","avatar_url":"https://github.com/makeplane.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Plane Node SDK\n\nA comprehensive TypeScript/JavaScript SDK for the Plane API, providing a clean and type-safe interface for all Plane operations.\n\n## Installation\n\n```bash\nnpm install @makeplane/plane-node-sdk\n```\n\n## ⚠️ Version 0.2.0 Breaking Changes\n\n**Important:** Version 0.2.0 introduces breaking changes with new API signatures. If you're migrating from version 0.1.x, please review the following:\n\n- **New PlaneClient Structure**: Instead of importing each API separately, you now use a single `PlaneClient` instance that provides access to all APIs\n- **Updated Method Signatures**: Method parameters and return types have been updated for better readability and consistency\n\n**Migration Guide:**\n\n- Replace individual API imports with the new `PlaneClient` approach\n- Review the new API documentation for updated method signatures\n- Test thoroughly in a development environment before upgrading\n\n## Quick Start\n\n```typescript\nimport { PlaneClient } from \"@plane/node-sdk\";\n\nconst client = new PlaneClient({\n  apiKey: \"your-api-key\",\n});\n\n// Or with custom base URL\nconst client = new PlaneClient({\n  baseUrl: \"https://your-custom-api.plane.so\",\n  accessToken: \"your-access-token\",\n});\n\n// List projects\nconst projects = await client.projects.list();\n\n// Create a project\nconst project = await client.projects.create(\"workspace-slug\", {\n  name: \"My Project\",\n  description: \"A new project\",\n});\n```\n\n## Features\n\n- ✅ TypeScript support with full type safety\n- ✅ Centralized HTTP logic with BaseResource\n- ✅ Automatic authentication handling\n- ✅ Modern async/await patterns\n- ✅ Extensible architecture\n\n## API Resources\n\n- **Projects**: Project management and organization\n- **WorkItems**: Issue and task management with full CRUD operations\n- **WorkItemTypes**: Custom work item type definitions and management\n- **WorkItemProperties**: Custom properties for work items\n- **Labels**: Issue categorization and tagging\n- **States**: Workflow state management\n- **Users**: User management and profiles\n- **Members**: Team membership and permissions\n- **Modules**: Feature organization and module management\n- **Cycles**: Sprint and iteration management\n- **Customers**: Customer management and operations\n- **Pages**: Workspace and project page management\n- **Links**: Work item linking and relationships\n- **Workspace**: Workspace-level operations\n- **Epics**: Epic management and organization\n- **Intake**: Intake form and request management\n- **Stickies**: Stickies management\n- **Teamspaces**: Teamspace management\n- **Initiatives**: Initiative management\n- **Features**: Workspace and project features management\n\n## Development\n\n```bash\n# Install dependencies\npnpm install\n\n# Build the project\npnpm build\n\n# Run tests\npnpm test\n\n# Lint code\npnpm lint\n\n# Format code\npnpm format\n```\n\n## Testing\n\n### Setup Test Environment\n\nBefore running tests, you need to configure your test environment:\n\n1. **Copy the environment template:**\n\n   ```bash\n   cp env.example .env.test\n   ```\n\n2. **Update `.env.test` with your test environment values:**\n\n   ```bash\n   # Edit the file with your actual test environment details\n   nano .env.test\n   ```\n\n3. **Required environment variables:**\n   - `TEST_WORKSPACE_SLUG`: Your test workspace slug\n   - `TEST_PROJECT_ID`: Your test project ID\n   - `TEST_USER_ID`: Your test user ID\n   - `TEST_WORK_ITEM_ID`: A test work item ID\n   - `TEST_CUSTOMER_ID`: A test customer ID\n   - And other test-specific IDs as needed\n\n### Running Tests\n\n```bash\n# Run all tests (recommended)\nnpm test\n# or\npnpm test\n\n# Run specific test files\npnpx ts-node tests/page.test.ts\n# or\npnpm test page.test.ts\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmakeplane%2Fplane-node-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmakeplane%2Fplane-node-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmakeplane%2Fplane-node-sdk/lists"}