Skip to content

[INFRA-396] feat: add workspace-level API resources#46

Open
mguptahub wants to merge 1 commit into
mainfrom
infra-396/node-sdk-workspace-level-apis
Open

[INFRA-396] feat: add workspace-level API resources#46
mguptahub wants to merge 1 commit into
mainfrom
infra-396/node-sdk-workspace-level-apis

Conversation

@mguptahub
Copy link
Copy Markdown

Summary

Mirrors the workspace-level resources from INFRA-394 (Python SDK) into the Node SDK. Adds 7 resource groups, all registered on PlaneClient and exported from the package index.

New resources:

  • WorkspaceTemplates — workspace work item, project, and page templates (list, create, update, del)
  • WorkspaceWorkItemTypes — list, create, update + properties sub-resource (list, create, del)
  • WorkspaceWorkItemProperties — list, create, update, del + options sub-resource (list, create, update)
  • WorkspaceProjectLabels — list, create, update, del
  • WorkspaceProjectStates — list, create, update, del
  • WorkItemRelationDefinitions — list (?is_default, ?is_active), create, update, del
  • Releases — list, create, update + tags, labels, itemLabels sub-resources

New models: WorkspaceTemplate.ts, WorkspaceProjectLabel.ts, WorkspaceProjectState.ts, WorkItemRelationDefinition.ts, Release.ts — all using Pick/Partial for DTO derivation. WorkspaceWorkItemTypePropertyLink added to WorkItemType.ts.

Workspace template naming: Prefixed with Workspace (e.g. WorkspaceWorkItemTemplate) to avoid collision with project-scoped WorkItemTemplate in ProjectTemplate.ts.

Test plan

  • Set PLANE_API_KEY, PLANE_BASE_URL, TEST_WORKSPACE_SLUG and run pnpm test
  • pnpm check:lint — 0 errors
  • pnpm check:format — all files correctly formatted
  • pnpm build — compiles cleanly

Co-authored-by: Plane AI noreply@plane.so

Mirrors the workspace-level resources from INFRA-394 (Python SDK) into
the Node SDK. Adds 7 resource groups, all registered on PlaneClient
and exported from the package index.

New resources:
- WorkspaceTemplates — workspace work item, project, and page templates (list, create, update, del)
- WorkspaceWorkItemTypes — list, create, update + properties sub-resource (list, create, del)
- WorkspaceWorkItemProperties — list, create, update, del + options sub-resource (list, create, update)
- WorkspaceProjectLabels — list, create, update, del
- WorkspaceProjectStates — list, create, update, del
- WorkItemRelationDefinitions — list (?is_default, ?is_active), create, update, del
- Releases — list, create, update + tags, labels, itemLabels sub-resources

New models:
- WorkspaceTemplate.ts (WorkspaceWorkItemTemplate, WorkspaceProjectTemplate, WorkspacePageTemplate)
- WorkspaceProjectLabel.ts, WorkspaceProjectState.ts
- WorkItemRelationDefinition.ts
- Release.ts (Release, ReleaseTag, ReleaseLabel, AddReleaseItemLabel)
- WorkspaceWorkItemTypePropertyLink added to WorkItemType.ts

Unit tests added for all resources. README updated.

Co-authored-by: Plane AI <noreply@plane.so>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 28, 2026

Warning

Review limit reached

@mguptahub, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 36 minutes and 45 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: eae5574a-2ef3-4db0-9ac1-5a27959bb4c1

📥 Commits

Reviewing files that changed from the base of the PR and between becbd90 and 3c658a1.

📒 Files selected for processing (31)
  • README.md
  • src/api/Releases/ItemLabels.ts
  • src/api/Releases/Labels.ts
  • src/api/Releases/Tags.ts
  • src/api/Releases/index.ts
  • src/api/WorkItemRelationDefinitions.ts
  • src/api/WorkspaceProjectLabels.ts
  • src/api/WorkspaceProjectStates.ts
  • src/api/WorkspaceTemplates/Pages.ts
  • src/api/WorkspaceTemplates/Projects.ts
  • src/api/WorkspaceTemplates/WorkItems.ts
  • src/api/WorkspaceTemplates/index.ts
  • src/api/WorkspaceWorkItemProperties/Options.ts
  • src/api/WorkspaceWorkItemProperties/index.ts
  • src/api/WorkspaceWorkItemTypes/Properties.ts
  • src/api/WorkspaceWorkItemTypes/index.ts
  • src/client/plane-client.ts
  • src/index.ts
  • src/models/Release.ts
  • src/models/WorkItemRelationDefinition.ts
  • src/models/WorkItemType.ts
  • src/models/WorkspaceProjectLabel.ts
  • src/models/WorkspaceProjectState.ts
  • src/models/WorkspaceTemplate.ts
  • src/models/index.ts
  • tests/unit/releases/releases.test.ts
  • tests/unit/work-item-relation-definitions.test.ts
  • tests/unit/workspace-project-labels.test.ts
  • tests/unit/workspace-project-states.test.ts
  • tests/unit/workspace-templates/workspace-templates.test.ts
  • tests/unit/workspace-work-item-types.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch infra-396/node-sdk-workspace-level-apis

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@makeplane
Copy link
Copy Markdown

makeplane Bot commented May 28, 2026

@mguptahub mguptahub requested a review from Prashant-Surya May 28, 2026 06:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant